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

docs(tutorial): Fix location of filename introduction #586

Merged
merged 3 commits into from
Apr 28, 2024

Commits on Apr 18, 2024

  1. 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.
    infinisil committed Apr 18, 2024
    Configuration menu
    Copy the full SHA
    82a33e2 View commit details
    Browse the repository at this point in the history

Commits on Apr 19, 2024

  1. Configuration menu
    Copy the full SHA
    0e0902c View commit details
    Browse the repository at this point in the history

Commits on Apr 28, 2024

  1. Configuration menu
    Copy the full SHA
    b19b1c9 View commit details
    Browse the repository at this point in the history