search

scientific-python / changelist

Prepare an automatic changelog from GitHub pull requests
BSD 3-Clause "New" or "Revised" License
8 stars 4 forks source link

Consider removing full-stop after each PR entry #25

Open stefanv opened 11 months ago

stefanv commented 11 months ago

Adds a bit of visual noise, when the hashtag-PR-number at the end of the line already indicates a clear line termination

lagru commented 11 months ago

In your opinion, how should changelist handle cases were the PR summary consists of more than one sentence? Delimit the leading sentences with ". " but omit from the last one?

Feels a bit too inconsistent and grammatically wrong to me, to be worth saving on visual noise.. my personal impression obviously. ;)

stefanv commented 11 months ago

I would just leave the PR description alone, i.e. f{PR_title} (#{PR_nr})

lagru commented 11 months ago

I feel like we discussed this before. I think I was advocating for a style similar to NumPy:

Some summary. Possibly with multiple sentences. ([#PR number](link))

For me the closing "." encourages to view of release notes as more than a list of scraped PR titles and as stated feels more consistent and correct. We are also doing it that way everywhere else in our documentation, e.g. parameter descriptions.

If you want to omit full-stops for the "visual noise" reason I'm -0.1, but if you want to have the option to list the summary as is without modification, than I am happy to add it as a configuration option. What do you think?

bsipocz commented 11 months ago

Unsolicited opinion from the sideline, but I also like full sentence(es) with a closing full stop before the PR number. But maybe it's just the style I'm used to. 

- Really short summary, preferably a single sentence. [[# PR number](link)]