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

using DocStringExtensins for documenting options #85

Open
sshin23 opened this issue Sep 15, 2021 · 0 comments
Open

using DocStringExtensins for documenting options #85

sshin23 opened this issue Sep 15, 2021 · 0 comments

Comments

@sshin23
Copy link
Member

sshin23 commented Sep 15, 2021

With DocStringExtensions, we can generate docstring for the Type's fields with the following syntax:

"""
This is an X
"""
struct X
    "This is a"
    a::String
    "This is b"
    b::Char
    "This is c"
    c
end

One shortcoming is that DocStringExtensions should be added to the dependency (not to the /doc/Project.toml, but to the main /Project.toml). But DocStringExtensions seems to be reasonably lightweight. See the discussion below:
https://discourse.julialang.org/t/documenting-elements-of-a-struct/64769

It seems to me that this might be the proper way to manage the long option documentation (which is generated manually for now). Let me know if there are any other alternatives

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

No branches or pull requests

1 participant