Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Scaladoc doesn't show Builder#addOne as abstract #19377

Closed
som-snytt opened this issue Jan 4, 2024 · 0 comments · Fixed by #19552
Closed

Scaladoc doesn't show Builder#addOne as abstract #19377

som-snytt opened this issue Jan 4, 2024 · 0 comments · Fixed by #19552
Assignees
@Florian3k
Labels
area:doctool itype:bug
Milestone
3.4.1

Comments

@som-snytt
Copy link
Contributor

Compiler version

Latest api

Minimized code

image

image

Expectation

image

I hate to rag on thankless scaladoc, but this strikes me as the low bar of usability. "What do I need to implement?"

Obviously, at the moment I am coding a quick test in vi with no autocomplete, so sue me.
@som-snytt som-snytt added itype:bug stat:needs triage Every issue needs to have an "area" and "itype" label labels Jan 4, 2024
@jchyb jchyb added area:doctool and removed stat:needs triage Every issue needs to have an "area" and "itype" label labels Jan 9, 2024
i10416 added a commit to i10416/dotty that referenced this issue Jan 28, 2024
@i10416
fix(scala#19377): show inherited abstract members in dedicated section
c823781 
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 i10416 mentioned this issue Jan 28, 2024
Merged
Florian3k added a commit that referenced this issue Feb 2, 2024
@Florian3k
fix(#19377): show inherited abstract members in dedicated section (#1…
5850d2d 
…9552)

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.

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


<img width="1334" alt="image"
src="https://github.com/lampepfl/dotty/assets/39330037/c033704d-0e30-49ff-954e-2c2ab0dace21">
@Kordyjan Kordyjan added this to the 3.4.1 milestone Feb 14, 2024
WojciechMazur pushed a commit that referenced this issue Jun 28, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
135d482 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
184622a 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
27be844 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
0f70221 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
9b6f35b 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
744043b 
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

[Cherry-picked c823781]
WojciechMazur pushed a commit that referenced this issue Jun 30, 2024
@i10416 @WojciechMazur
fix(#19377): show inherited abstract members in dedicated section
5cb8264 
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

[Cherry-picked c823781]
WojciechMazur added a commit that referenced this issue Jul 1, 2024
@WojciechMazur
Backport "fix(#19377): show inherited abstract members in dedicated s…
e12999e 
…ection" to LTS (#20881)

Backports #19552 to the LTS branch.

PR submitted by the release tooling.
[skip ci]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Florian3k Florian3k

Labels
area:doctool itype:bug
Projects
None yet
Milestone
3.4.1
Development

Successfully merging a pull request may close this issue.

fix(#19377): show inherited abstract members in dedicated section i10416/dotty
5 participants
@som-snytt @Kordyjan @Florian3k @jchyb and others