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

help parameter #1103

Closed
jfindlay opened this issue Feb 23, 2023 · 4 comments
Closed

help parameter #1103

jfindlay opened this issue Feb 23, 2023 · 4 comments

Comments

@jfindlay
Copy link

What is the recommended way to add a documentation or a description or a help string to an attribute? I am thinking of something similar to the argparse help keyword. I have not been able to find anything like this in the documentation or source.

I can always annotate each attr.ib with a comment where they are defined in the source code, but it seems like a field that could naturally be bundled into the attr itself.

@chrysle
Copy link
Contributor

chrysle commented Feb 24, 2023

What is the recommended way to add a documentation or a description or a help string to an attribute?

You want to generate a comment in the source code?

@webknjaz
Copy link
Member

I think they want some way of exposing __doc__...?

@hynek
Copy link
Member

hynek commented Feb 24, 2023

There a ticket on this but I’m too much on a vacation to find it.

@chrysle
Copy link
Contributor

chrysle commented Feb 24, 2023

There a ticket on this but I’m too much on a vacation to find it.

I think it's #357

@jfindlay jfindlay closed this as not planned Won't fix, can't repro, duplicate, stale Feb 24, 2023
@jfindlay jfindlay reopened this Feb 24, 2023
@jfindlay jfindlay closed this as not planned Won't fix, can't repro, duplicate, stale Feb 24, 2023
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

4 participants