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

[FR] rework auto-generated docstrings #4504

Closed
t-bltg opened this issue Nov 9, 2022 · 0 comments · Fixed by #4525
Closed

[FR] rework auto-generated docstrings #4504

t-bltg opened this issue Nov 9, 2022 · 0 comments · Fixed by #4525
Labels
documentation - API enhancement improving existing functionality

Comments

@t-bltg
Copy link
Member

t-bltg commented Nov 9, 2022

While working on #4503.

Currently, taking the fillrange keyword argument in a docstring:

  Arguments
  ≡≡≡≡≡≡≡≡≡≡≡

    •  fillrange: Number or AbstractVector. Fills area between fillrange and y for line-types, sets the base for
       bar/stick types, and similar for other types.

I think the auto-generated docstrings would benefit from:

  • adding the allowed type(s) as an Union suffix (in the form of fillrange::Union{Number,AbstractVector}: <description>);
  • add aliases list at the end of the description (fillrange <description> aliases = (fillrng, frange, fillto, fill_between));
  • enhance function descriptions in general (src/shorthands.jl).

TBD.

@t-bltg t-bltg added enhancement improving existing functionality documentation - API labels Nov 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation - API enhancement improving existing functionality
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant