Remove Documentation type from Reflect #10608
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
|
Removing the |
nicolasstucki
approved these changes
Dec 3, 2020
|
@abgruszecki this PR needs to be rebased |
abgruszecki
force-pushed
the
scala3doc/tasty-reflect-hide-comments
branch
2 times, most recently
from
7f51b39 to
d26e8b6
Compare
nicolasstucki
suggested changes
Dec 7, 2020
| @@ -2294,14 +2294,14 @@ class QuotesImpl private (using val ctx: Context) extends Quotes, QuoteUnpickler | |||
| def pos: Option[Position] = | |||
| if self.exists then Some(self.sourcePos) else None | |||
|
|
|||
| def documentation: Option[Documentation] = | |||
| def docstring: Option[String] = | |||
There was a problem hiding this comment.
Suggested change
| def docstring: Option[String] = | |
| def docString: Option[String] = |
| @@ -3070,7 +3068,7 @@ trait Quotes { self: runtime.QuoteUnpickler & runtime.QuoteMatching => | |||
| def pos: Option[Position] | |||
|
|
|||
| /** The documentation for this symbol, if any */ | |||
| def documentation: Option[Documentation] | |||
| def docstring: Option[String] | |||
There was a problem hiding this comment.
Suggested change
| def docstring: Option[String] | |
| def docString: Option[String] |
| def documentation = sym.documentation match | ||
| case Some(comment) => | ||
| Map(ctx.sourceSet -> parseComment(comment, sym.tree)) | ||
| def documentation = sym.docstring match |
There was a problem hiding this comment.
Suggested change
| def documentation = sym.docstring match | |
| def documentation = sym.docString match |
| @@ -21,8 +21,8 @@ class DocumentationInspector extends TastyInspector { | |||
|
|
|||
| override def traverseTree(tree: Tree)(owner: Symbol): Unit = tree match { | |||
| case tree: Definition => | |||
| tree.symbol.documentation match { | |||
| case Some(doc) => println(doc.raw) | |||
| tree.symbol.docstring match { | |||
There was a problem hiding this comment.
Suggested change
| tree.symbol.docstring match { | |
| tree.symbol.docString match { |
nicolasstucki
changed the title
|
@nicolasstucki https://www.google.com/search?hl=en&q=docstring |
|
It is the only method that is not camelCase in this API. |
|
It is in camel case, it's just that it's spelled |
|
ok |
nicolasstucki
approved these changes
Dec 7, 2020
Nothing but the .raw field is set when we load documentation from Tasty. It doesn't make sense to expose Documentation as a separate data type.
abgruszecki
force-pushed
the
scala3doc/tasty-reflect-hide-comments
branch
from
d26e8b6 to
eae6d18
Compare
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.
Nothing but the .raw field is set when we load documentation from Tasty. Right now, it doesn't make sense to expose
Documentationas a separate type.It might make sense to expose it later when we decide how exactly we expose cooking comments.