Skip to content

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

Closed

Description

@kMutagene

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.

Activity

  1. added a commit that references this issue on Jun 12, 2020
  2. added this to the 2.0 milestone on Jun 15, 2020
  3. kMutagene commented on Apr 13, 2021

    @kMutagene
    CollaboratorAuthor

    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.

  4. added a commit that references this issue on Apr 13, 2021
  5. kMutagene commented on Jun 25, 2021

    @kMutagene
    CollaboratorAuthor

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

  6. dsyme commented on Mar 17, 2022

    @dsyme

    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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions