Skip to content

Markdown cleanup/style#111

Merged
fmalatino merged 2 commits intoNOAA-GFDL:developfrom
romanc:romanc/md-cleanup
Mar 24, 2025
Merged

Markdown cleanup/style#111
fmalatino merged 2 commits intoNOAA-GFDL:developfrom
romanc:romanc/md-cleanup

Conversation

@romanc
Copy link
Copy Markdown
Collaborator

@romanc romanc commented Mar 24, 2025

Description

This PR cleans up README.md and CONTRIBUTING.md with respect to markdown style. In particular we ensure

  • consistent whitespace around headers and code blocks
  • only fenced code blocks
  • for shell code blocks, the $ sign implies that output is shown. Since there's no output, I removed them.

How Has This Been Tested?

I use markdownlint in VSCode to show violations of common markdown syntax/style.

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas: N/A
  • I have made corresponding changes to the documentation: N/A
  • My changes generate no new warnings: N/A
  • Any dependent changes have been merged and published in downstream modules: N/A
  • New check tests, if applicable, are included: N/A

romanc added 2 commits March 24, 2025 10:44
Consistent markdown formatting in the top-level README file.
- consistent whitespace around headers and code blocks
- fenced code blocks
- for shell commands, only include `$` if you also show the output
@romanc
Copy link
Copy Markdown
Collaborator Author

romanc commented Mar 24, 2025

@fmalatino can't assign reviewers due to lacking permissions. Please have a look. Thanks!

@romanc
Copy link
Copy Markdown
Collaborator Author

romanc commented Mar 24, 2025

@fmalatino thanks for approving. Please merge yourself. I don't have rights to merge in this repo. Thanks 🙏

@fmalatino fmalatino merged commit 81f3c63 into NOAA-GFDL:develop Mar 24, 2025
2 checks passed
@romanc romanc deleted the romanc/md-cleanup branch March 24, 2025 13:31
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 this pull request may close these issues.

2 participants