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

Better section documentation #613

Open
SmileyChris opened this issue Jun 13, 2024 · 0 comments
Open

Better section documentation #613

SmileyChris opened this issue Jun 13, 2024 · 0 comments
Labels

Comments

@SmileyChris
Copy link
Contributor

From @adiroiban comments in #603

Especially the part from Section Path Behaviour is confusing.

I think that it needs better example.

For example

If directory is not set, “newsfragments” is added to the end of each path. For example, with the above sections, the paths would be:

Which directory , I guess that this is [tool.towncrier] -> directory

I agree the docs should be better. Probably a top level file rather than a section within the configuration docs would be actually better.

Also, the doc example I think I wrote a long time ago because the current behaviour wasn't explained at all (and it's confusing behaviour!)

@adiroiban adiroiban added the docs label Jun 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants