Skip to content

docs: Fix duplicate word typo in README.md and heading anchor in cli-options.md - #395

Merged
dlebauer merged 2 commits into
PecanProject:masterfrom
Jah-yee:main
Sep 3, 2026
Merged

docs: Fix duplicate word typo in README.md and heading anchor in cli-options.md#395
dlebauer merged 2 commits into
PecanProject:masterfrom
Jah-yee:main

Conversation

@Jah-yee

@Jah-yee Jah-yee commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Description

Fixes two documentation issues reported in issue #388.

1. Duplicate word in docs/README.md

  • Line 60: Removed duplicate with in the v1.0.0 release note
  • Before: model with with improved hydrology
  • After: model with improved hydrology

2. Broken heading anchor in docs/developer-guide/cli-options.md

  • Line 14: Removed {#naming} attribute from ### Naming heading
  • The {#naming} syntax caused GitHub to generate anchor #naming--naming, breaking the internal link [Naming](#naming)

Testing

  • Verified both files parse correctly as Markdown
  • No functional code changes

Closes #388

…ns.md

Fix issue PecanProject#388:
- docs/README.md line 60: remove duplicate 'with' in 'model with with improved'
- docs/developer-guide/cli-options.md: remove {#naming} attribute from '### Naming' heading

Fixes the broken internal link on GitHub ({#naming} caused anchor to be #naming--naming)

@dlebauer dlebauer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @Jah-yee !

@dlebauer
dlebauer enabled auto-merge (squash) September 3, 2026 15:36
@dlebauer
dlebauer merged commit caf7e9f into PecanProject:master Sep 3, 2026
11 checks passed
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.

docs: Fix duplicate word typo in README.md and heading anchor in cli-options.md

2 participants