Skip to content

dartdoc should group extension method with the class being extended if they are in the same import #2854

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
brianquinlan opened this issue Nov 11, 2021 · 2 comments

Comments

@brianquinlan
Copy link

Motivation:

  1. I want to know more about Futures
  2. I google for "Future dart" and end up on the Future<T> documentation page
  3. I miss the existence of the ignore method because it is documented separately in the Extensions section

In this case, ignore is implemented as an extension method for compatibility reasons (adding a method to an existing class can break 3p code that implements that class) not because it is logically separate from the class.

Ideally, if the extension method is defined in the same package, it would be documented with the class or, at minimum, a link to the related extensions should be shown.

@srawlins
Copy link
Member

+1 this is a great idea.

@srawlins
Copy link
Member

Duplicate of #2021

@srawlins srawlins marked this as a duplicate of #2021 Mar 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants