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

Things to explain in the docs #11

Open
nedbat opened this issue Sep 21, 2020 · 2 comments
Open

Things to explain in the docs #11

nedbat opened this issue Sep 21, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@nedbat
Copy link
Owner

nedbat commented Sep 21, 2020

Based on questions people asked when I announced scriv, these things need explaining:

  • "Do you have a demo of how fragment categories are selected?"
@webknjaz
Copy link
Contributor

Also:
2) The docs mention the ability to write change notes for different audiences. How is this achieved? Do I understand correctly that I can write the same text twice but with different accents: for example, one for devs (like private API and/or implementation changes), and the other for end-users (or lib users, like public API changes)

@nedbat nedbat added the documentation Improvements or additions to documentation label Oct 2, 2020
@webknjaz
Copy link
Contributor

webknjaz commented Oct 17, 2020

Another one:
3) There's this problem that surfaced with towncrier: we've changed the template to include category names and since they were missing, and now only new releases will use that template so we have to find a way to retrospectively extract the fragments to reconstruct the changelog with a new template (pypa/setuptools#2399 (comment)). What if I change the template in scriv and want to update how the changelog looks? Is there any recommended/suppoprted way of doing that? I noticed there's --keep but the docs don't exactly describe what will happen if I keep the fragments in the tree.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants