Skip to content

docs: Start markdown headers with capital letter where applicable #14115

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

Closed
wants to merge 1 commit into from
Closed

docs: Start markdown headers with capital letter where applicable #14115

wants to merge 1 commit into from

Conversation

Kotbenek
Copy link
Contributor

@Kotbenek Kotbenek commented Jul 7, 2024

This patch consistently capitalizes the first word of each markdown header where applicable.

@bagder
Copy link
Member

bagder commented Jul 8, 2024

I'm not convinced with need to insist on capitalization in headers. There are numerous additional markdown headers that also start with lowercase.

@Kotbenek
Copy link
Contributor Author

Kotbenek commented Jul 9, 2024

Thank you for your insight.

There are indeed some markdown headers starting with lowercase, although they start with words like curl, and they are meant to be written with lowercase, I think.

Other headers, except the ones changed in the patch, are in fact fully capitalized (most of the docs), or fully in lowercase (BUFQ.md).

The thing that made me create this PR was seeing docs/INSTALL.md, beginning with lowercase how to install curl and libcurl, followed by capitalized headers - it just does not seem consistent to me.

@bagder bagder closed this in 95776c9 Jul 10, 2024
@bagder
Copy link
Member

bagder commented Jul 10, 2024

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants