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

Use DocStringExtensions in Gadfly #1161

Closed
tlnagy opened this issue Jun 4, 2018 · 3 comments · Fixed by #1173
Closed

Use DocStringExtensions in Gadfly #1161

tlnagy opened this issue Jun 4, 2018 · 3 comments · Fixed by #1173

Comments

@tlnagy
Copy link
Member

tlnagy commented Jun 4, 2018

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 on Compat and Base). A couple examples of where we can leverage it:

  1. By using the automatically generated function signatures in the docstrings (so they don't get out sync) with the actual functions

  2. 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 with DocStringExtension.jl

Thoughts?

@bjarthur
Copy link
Member

bjarthur commented Jun 4, 2018

auto-gen'd sigs sounds great, but where besides #1157 are docs embedded in typedefs?

@bjarthur
Copy link
Member

i can see the value in DocStringExtensions. #1173 proposes to use it.

@tlnagy
Copy link
Member Author

tlnagy commented Jul 27, 2018

Since it seems like we're generally onboard with using it, I'll go ahead and close this

@tlnagy tlnagy closed this as completed Jul 27, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants