Dottydoc: Keep documentation on package objects #4573
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The documentation for packages must be set on the package object. When generating the docsite, dotty doc must then copy the documentation from the package object node to the package node, so that it is shown in the index for this package. In dotty doc, the comments are added to the "doc AST" in the `DocstringPhase`. Then, the doc for packages are copied from the matching package objects in the `PackageObjectsPhase`. This means that `PackageObjectsPhase` must be able to see the changes done by `DocstringPhase`, and therefor they cannot be in the same miniphase.
allanrenucci
approved these changes
Jul 9, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The documentation for packages must be set on the package object. When
generating the docsite, dotty doc must then copy the documentation from
the package object node to the package node, so that it is shown in the
index for this package.
In dotty doc, the comments are added to the "doc AST" in the
DocstringPhase. Then, the doc for packages are copied from thematching package objects in the
PackageObjectsPhase.This means that
PackageObjectsPhasemust be able to see the changesdone by
DocstringPhase, and therefor they cannot be in the sameminiphase.