Skip to content

Add names to using parameters for cleaner docs #10518

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

Conversation

nicolasstucki
Copy link
Contributor

No description provided.

@nicolasstucki nicolasstucki force-pushed the use-names-for-public-using-parameters branch from 14b4c78 to 53d283f Compare November 26, 2020 17:27
@nicolasstucki nicolasstucki marked this pull request as ready for review November 26, 2020 17:37
@odersky
Copy link
Contributor

odersky commented Nov 26, 2020

I am not sure this is a good idea. These names are just noise. What is the problem with the docs if they are left out? Maybe we need to upgrade the doc tool to handle this gracefully?

@nicolasstucki
Copy link
Contributor Author

nicolasstucki commented Nov 26, 2020

There are two issues

  • All names appear as x$i
  • We cannot refer to names in the @param in the docs

@arturopala
Copy link
Contributor

What about adding @using annotation to the docs, accepting type name rather than parameter name? This would help to understand better the definition.

@nicolasstucki
Copy link
Contributor Author

I will create an issue for this.

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

Successfully merging this pull request may close these issues.

4 participants