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.

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

Generated parameter documentation #99

Open
Tamschi opened this issue Feb 24, 2022 · 0 comments
Open

Generated parameter documentation #99

Tamschi opened this issue Feb 24, 2022 · 0 comments
Assignees
Labels
accepted This will be worked on domain: Rust Involves Rust code. effort: 2 Relative effort required. There's no specific unit of measurement. priority: next I'll probably get to it, eventually. type: feature Brand new functionality, features, pages, workflows, endpoints, etc. work: clear A known solution is (to be) implemented.

Comments

@Tamschi
Copy link
Owner

Tamschi commented Feb 24, 2022

Is your feature request related to a problem? Please describe.

Currently, there is no easily visible documentation for which arguments a component accepts.
The args builders are largely hidden from documentation.

Describe the solution you'd like

Ideally, the parameters docs should be appended as bulleted list to the documentation of the component itself. Doc comments placed on parameter declarations should be taken into account and they should also be replicated on the builder's setter methods.

Describe alternatives you've considered

An eventual args builder rework may solve this differently, but that is still a way off.

Additional context

This issue came about because the individual component methods don't have documentation attached and as such produce warnings, but that is not directly related, since the method docs currently aren't surfaced in the IDE. (Ideally, they would be, but I'm unsure where I should put them.)

@Tamschi Tamschi added type: feature Brand new functionality, features, pages, workflows, endpoints, etc. accepted This will be worked on domain: Rust Involves Rust code. work: clear A known solution is (to be) implemented. priority: next I'll probably get to it, eventually. effort: 2 Relative effort required. There's no specific unit of measurement. labels Feb 24, 2022
@Tamschi Tamschi self-assigned this Feb 24, 2022
@Tamschi Tamschi added this to To do in Robustness and Ease of Use via automation Feb 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted This will be worked on domain: Rust Involves Rust code. effort: 2 Relative effort required. There's no specific unit of measurement. priority: next I'll probably get to it, eventually. type: feature Brand new functionality, features, pages, workflows, endpoints, etc. work: clear A known solution is (to be) implemented.
Development

No branches or pull requests

1 participant