Add docs for CLI orphan fragments#589
Conversation
There was a problem hiding this comment.
Thanks. This is much better. Much appreciated :)
I was always confused by the orphan thing...as I don't use or need it
I think is best to also mention this behaviour in the create docstring
towncrier/src/towncrier/create.py
Lines 46 to 68 in 914b446
In this way, the info is found in towncrier create --help
The idea is that in the future we can just run some helper utility for click and it will automatically generate the .RST documentation for the CLI.
I think is best to keep as much info as possible into the --help part.
For the --help docstring , we can keep the info brief,
Just mention that you can use + as the ticket number and towncrier will auto-generate
More info and examples, can be found in the RST version.
Thanks again
|
Thanks Chris. I have merged this. I added you to the list of maintainer, so if the future you should be able to merge a PR once it is approved. Just make sure that any change is reviewed and approved before a merge. Thanks again! |
towncrier create +.feature.rstwasn't documented.