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

Increase verbosity of Markdown comments for hoverinfo of Chart functions #40

Closed
kMutagene opened this issue Jun 7, 2020 · 3 comments
Closed

Comments

@kMutagene
Copy link
Member

It seems like due to the Chart creating functions being static members of a class with optional arguments, the single parameters cannot be documented via markdown comments. Therefore, i would suggest we add a verbose description to the member itself that lists the key information about each argument for the chart.

@kMutagene kMutagene mentioned this issue Jun 15, 2020
13 tasks
@kMutagene kMutagene added this to the 2.0 milestone Jun 15, 2020
kMutagene added a commit that referenced this issue Jun 16, 2020
#42: Add option to render all charts derived from the scatter trace type via WebGL as scattergl trace

#40: Add markdown comments for all  all charts derived from the scatter trace
@kMutagene
Copy link
Member Author

As xml doc support for F# has improved and the docs auto generate content from this type of inline docs, a switch to xml documentation seems ideal.

@kMutagene
Copy link
Member Author

It is now especially usefull to use xml documentation, as it will greatly improve the API documentation

@dsyme
Copy link

dsyme commented Mar 17, 2022

This is great - yes, for now all F# libraries should be using XML

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants