docs/config.rst: State in config directive sections their ini file sections #3194
Conversation
0cjs
force-pushed
the
dev/cjs/24a20/doc-ini-sections
branch
from
53d7772 to
394f85c
Compare
|
Ok, it's not at all clear to me what's going on with the "timeline protection" thing (maybe requiring a changelog entry for every commit? Why not just generate that from the commit message, then?), and your developer documentation doesn't mention anything about it, so I'll just let you sort the rest of that out. Also, the way that Regarding the various conversations here, they look to me better as separate PRs, which I will cons up once this one goes through. |
|
Yes, you do need to create a changelog file for every pull request. The commit messages serve a different purpose so it's not advisable to generate it from it. PR improving the contribution guides is also welcome. Technically, you don't need to worry about the draft file, that is an implementation detail and is automatically managed from the changelog files you add to the PRs. |
|
Ok. Small documentation changes are not the sort of thing I'd normally want to see in a changelog, but each to his own. I do have a concern about the issue number. if I include the one that mentions this, it will not close the issue when the fix is merged, will it? (This PR does not solve the issue.) If it does, should I create a separate issue referencing this first, or leave the issue number out of the changelog entry? |
|
You can also use the car PR number as the issue number. |
…ctions The config file documentation is in essentially three parts: config files and their sections, directives for the global config section, and directives for the environment sections. For the second and third parts, state again what config file sections they belong in. (This is arguably redundant, but the page as a whole is long enough that it's good to clarify this at the head of the directives in the not-unlikely case that a new user didn't carefully peruse and understand the initial section.)
0cjs
force-pushed
the
dev/cjs/24a20/doc-ini-sections
branch
from
394f85c to
e973166
Compare
|
I'm not clear on why merging is blocked on this. The message says only, "Merging can be performed automatically with 0 approving reviews," and the other two sections ("All conversations are resolved" and "All checks have passed") are green. Is there something else I should be doing here? |
[Full description in the commit message(s).]
tox -e fix)docs/changelogfolderI did not copy the commit messages into the pull request because Say everything once and only once.
The tests validating the fix are
tox -e docs; these pass. (And these are useful; they caught an RST syntax error.)I did not add a new fragment to the changelog because this seems too small to bother readers of that file with.
The full set of tests (
tox) has at least one failure; this occurs on themainbranch also.