docs(tutorial): Fix location of filename introduction

[infinisil]

Description

Previously the filename option was only mentioned in the Python-specific section. This moves it earlier to the correct place.

Checklist

• [x] Make sure all GitHub Actions checks are green (they are automatically checking all of the above).
• [x] Ensure docs/tutorial.rst is still up-to-date.

[adiroiban]

Thanks for the change.

The result is here https://towncrier--586.org.readthedocs.build/en/586/tutorial.html

---

[infinisil]

Currently, the tutorial contains this part:

The most basic configuration is just telling towncrier where to look for news fragments:

[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:

[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.

---

filename is not a required argument and for now it defaults to NEWS.rst

Ah I didn't know that. I think it's still worth pointing out that it can be specified to avoid the above confusion, maybe something like this:

[tool.towncrier]
directory = "changes"
# Where you want your news files to come out, `NEWS.rst` is the default.
# This can be .rst or .md, towncrier's default template works with both.
# filename = "NEWS.rst"

[adiroiban]

Many thanks for your feedback.

The feedback from people new to the project is critical.

Ah I didn't know that. I think it's still worth pointing out that it can be specified to avoid the above confusion, maybe something like this:

Agree.

Beside changing the configuration example, I think that is important to also update the narrative doc paragraph from above that introduces the example.

I left an inline comment for that.

Thanks

[adiroiban]

Thanks for the update. I have enabled auto-merge. I hope this will get merged soon.