Skip to content

Updating docs at dotty.epfl.ch #10633

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
4 of 16 tasks
b-studios opened this issue Dec 3, 2020 · 2 comments
Open
4 of 16 tasks

Updating docs at dotty.epfl.ch #10633

b-studios opened this issue Dec 3, 2020 · 2 comments
Assignees

Comments

@b-studios
Copy link
Contributor

b-studios commented Dec 3, 2020

We need to make sure that the documentation at https://dotty.epfl.ch/docs/reference/overview.html is sound and complete with respect to the release candidate.

In this umbrella issue, we can collect necessary changes. Feel free to edit the issue text or add comments if you think something needs to be changed.

I propose the following categorisation of changes.

Incomplete / Incorrect Documentation

Features where some documentation is missing or need to be changed in details.

Missing Features

Features that are not documented at all.

Deprecated Features

Features that are documented but will not be part of the release.

Other Aspects

  • update all of the documentation to indentation based syntax (once it has been formally accepted) to be consistent with the other resources (Scala 3 book etc.).
  • once we move the reference docs to another location, we also need to change the doc-comments (like the ones here)
@b-studios b-studios added this to the 3.0.0-M3 milestone Dec 3, 2020
@b-studios b-studios self-assigned this Dec 3, 2020
@LPTK
Copy link
Contributor

LPTK commented Dec 4, 2020

I could write some documentation for polymorphic function types, if no one else is going to do it.

@japgolly
Copy link
Contributor

Got another one: #11766

@anatoliykmetyuk anatoliykmetyuk modified the milestones: 3.0.0-RC2, 3.0.x Mar 22, 2021
@anatoliykmetyuk anatoliykmetyuk modified the milestones: 3.0.x, 3.0.1-RC1 May 12, 2021
@smarter smarter removed this from the 3.0.1-RC1 milestone May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants