fix(#19377): show inherited abstract members in dedicated section #19552
Conversation
This file contains 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
Before this commit, inherited abstract members are displayed in "Inherited members" section, which made it a bit difficult for developers to figure out which method to be implemented. I think there are two solution for the issue. 1. display `abstract` modifier for methods in inherited section 2. add a new dedicated section for inherited abstract members I choose the 2nd solution because - it is easier for developers to find methods to be implemented in a dedicated section rather than to look up abstract ones from all the inherited members - it requires smaller modification to scaladoc codebase
i10416
commented
Jan 28, 2024
| @@ -323,6 +323,7 @@ class MemberRenderer(signatureRenderer: SignatureRenderer)(using DocContext) ext | |||
| val (allInherited, allDefined) = nonExperimental.partition(isInherited) | |||
| val (depDefined, defined) = allDefined.partition(isDeprecated) | |||
| val (depInherited, inherited) = allInherited.partition(isDeprecated) | |||
| val (abstractInherited, concreteInherited) = inherited.partition(isAbstract) | |||
There was a problem hiding this comment.
Note:
If we just put inherited abstract members into "Abstract members" section, it loses the information that these methods are originated from inheritance.
Florian3k
approved these changes
Feb 2, 2024
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.
close #19377
Before this commit, inherited abstract members are displayed in "Inherited members" section, which made it a bit difficult for developers to figure out which method to be implemented.
I think there are two solution for the issue.
abstractmodifier for methods in inherited sectionI choose the 2nd solution because