Skip to content

The content of docs/_docs/usage/coverage.md is not at the right place #15110

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

Closed
julienrf opened this issue May 5, 2022 · 0 comments · Fixed by #15152
Closed

The content of docs/_docs/usage/coverage.md is not at the right place #15110

julienrf opened this issue May 5, 2022 · 0 comments · Fixed by #15152
Labels
area:documentation good first issue Perfect for someone who wants to get started contributing itype:enhancement stat:unassigned This issue or PR is not assigned to anyone, but should be

Comments

@julienrf
Copy link
Contributor

julienrf commented May 5, 2022

I think the website https://dotty.epfl.ch should host the “nightly” documentation (as opposed to the website https://docs.scala-lang.org, which contains the documentation for the latest stable release of the compiler). Furthermore, https://dotty.epfl.ch should only contain the sections “reference”, “api”, and “internals”. Documentation directed to end-users should go to https://docs.scala-lang.org.

With this in mind, I believe that the file docs/_docs/usage/coverage.md is not at the right place. It covers multiple aspects of code coverage, which should be put in the following places:

  • Usage instructions should be put in the documentation of sbt-scoverage,
  • The compiler option -coverage-out could be mentioned in the compiler options migration (it seems that we don’t have an equivalent of this page for Scala 3),
  • The documentation about the internals should go to the dotty internal documentation (under docs/_docs/internal).

Originally posted by @julienrf in #15099 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:documentation good first issue Perfect for someone who wants to get started contributing itype:enhancement stat:unassigned This issue or PR is not assigned to anyone, but should be
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants