Skip to content

Fix typos in usage examples#1842

Merged
groue merged 1 commit intogroue:developmentfrom
Cykelero:fix-usage-example-typos
Jan 9, 2026
Merged

Fix typos in usage examples#1842
groue merged 1 commit intogroue:developmentfrom
Cykelero:fix-usage-example-typos

Conversation

@Cykelero
Copy link
Copy Markdown
Contributor

@Cykelero Cykelero commented Jan 9, 2026

Fixes two tiny typos in the readme. Including one in the “getting started in four steps” example, so that felt important!

Pull Request Checklist

@groue
Copy link
Copy Markdown
Owner

groue commented Jan 9, 2026

Thank you very much @Cykelero! 😊

@groue groue changed the base branch from development to master January 9, 2026 15:28
@groue
Copy link
Copy Markdown
Owner

groue commented Jan 9, 2026

(Thank you for picking development as the target branch 👍 In this particular case, I'm switching it to master so that the documentation fix is immediately available)

@groue groue changed the base branch from master to development January 9, 2026 15:30
@groue
Copy link
Copy Markdown
Owner

groue commented Jan 9, 2026

Ooops no, this brings undesired commits in the PR. OK, so development it is 🤷‍♂️

@groue groue merged commit ccfe314 into groue:development Jan 9, 2026
@Cykelero
Copy link
Copy Markdown
Contributor Author

Cykelero commented Jan 9, 2026

Ohh, cool to see the changed merged so quickly. I’ll remember about the master/development distinction for next time!

@groue
Copy link
Copy Markdown
Owner

groue commented Jan 9, 2026

Please keep development as the default target branch, as documented! In this case master would have been ok, because it's all just wording and documentation changes. But this kind subtlety should not be pushed on to the gentle contributors, see what I mean? A plain and simple rule is better for all.

@Cykelero
Copy link
Copy Markdown
Contributor Author

Cykelero commented Jan 9, 2026

Yes, I understand! Targeting master is only OK for changes that are 100% inoffensive, guaranteed to be usable right away. So probably pretty rarely.

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