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

Consider removing full-stop after each PR entry #25

Open
stefanv opened this issue Sep 22, 2023 · 4 comments
Open

Consider removing full-stop after each PR entry #25

stefanv opened this issue Sep 22, 2023 · 4 comments
Labels
type: Enhancement New feature or request

Comments

@stefanv
Copy link
Member

stefanv commented Sep 22, 2023

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

@lagru
Copy link
Member

lagru commented Sep 23, 2023

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. ;)

@lagru lagru added the type: Enhancement New feature or request label Sep 23, 2023
@stefanv
Copy link
Member Author

stefanv commented Sep 23, 2023

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

@lagru
Copy link
Member

lagru commented Oct 2, 2023

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
Copy link
Member

bsipocz commented Oct 2, 2023

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)]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: Enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants