Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(tutorial): Improve location of filename introduction
Currently, the tutorial contains this part: > The most basic configuration is just telling towncrier where to look for news fragments: > > ```toml > [tool.towncrier] > directory = "changes" > ``` > > Which will look into “./changes” for news fragments and write them into “./NEWS.rst”. Note the `and write them into “./NEWS.rst”.`. This confused me when reading, because while I clearly saw how `./changes` was specified, it's not clear why `./NEWS.rst` would be used. Only after reading the next paragraph the connection can be made, but that section is about Python specifically: > If you’re working on a Python project, you can also specify a package: > > ```toml > [tool.towncrier] > # The name of your Python package > package = "myproject" > # The path to your Python package. > # If your package lives in 'src/myproject/', it must be 'src', > # but if you don't keep your code in a 'src' dir, remove the > # config option > package_dir = "src" > # Where you want your news files to come out. This can be .rst > # or .md, towncrier's default template works with both. > filename = "NEWS.rst" > ``` But there it's very easy to miss. This commit moves the introduction of the filename option to the earlier section to avoid such confusion. Furthermore we indicate that there's no need to set the option because there's a default.
- Loading branch information