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

Make headers in README.md consistent #41

Closed
matt-development-work opened this issue Nov 30, 2020 · 1 comment · Fixed by #43
Closed

Make headers in README.md consistent #41

matt-development-work opened this issue Nov 30, 2020 · 1 comment · Fixed by #43

Comments

@matt-development-work
Copy link
Contributor

I realized that the headers I added for the directory descriptions in #38 are not consistent.

(e.g. the header for the "audio-basics" directory is "Audio Basics" and the header for the "decode-audio-data" is "decodeAudioData"). I did this because some directory names are associated with a specific method, whereas others are more of a description.

For consistency purposes, I think it makes sense for all headers to be capital letters separated by spaces. If there is a method name associated with the directory, then it will appear in the description.

Thoughts on this, @chrisdavidmills?

@matt-development-work matt-development-work changed the title Make headers in README consistent Make headers in README.md consistent Nov 30, 2020
@chrisdavidmills
Copy link
Contributor

@matt-eric sure, that makes sense to me. All I'd add is that MDN standard practice is for headings to use sentence case rather than all capitalized, so I'd prefer that.

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

Successfully merging a pull request may close this issue.

2 participants