-
Notifications
You must be signed in to change notification settings - Fork 250
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
Use DocStringExtensions in Gadfly #1161
Labels
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
DocStringExtensions.jl
is a really nice self-contained package that allows us to have much more flexible and dynamic docstrings. I'm very wary of adding more dependencies to Gadfly, but this package would add no subdependencies (it only depends onCompat
andBase
). A couple examples of where we can leverage it:By using the automatically generated function signatures in the docstrings (so they don't get out sync) with the actual functions
By unrolling the fields in a type (see https://github.com/GiovineItalia/Gadfly.jl/pull/1157/files#diff-9ec506bf78232ae17d082c22c2e66449R507). Currently, all those docs are hidden when you do
?Gadfly.Stat.density
, but could be unrolled withDocStringExtension.jl
Thoughts?
The text was updated successfully, but these errors were encountered: