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

docs: clean up README examples #23

Merged

Conversation

shadowspawn
Copy link
Collaborator

If this is acceptable, happy to update the code to behave accordingly.

- remove option overwrites
- remove array for plain values
- flags for flags, values for values
Copy link
Collaborator

@Eomm Eomm left a comment

Choose a reason for hiding this comment

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

Did you consider generating these docs?
It seems easy to get it out of sync

README.md Outdated Show resolved Hide resolved
@shadowspawn
Copy link
Collaborator Author

shadowspawn commented Dec 22, 2021

Did you consider generating these docs?

Not yet. The docs got written first, and guided the initial implementation. I am proposing changes to README, then will update code to match. 😄

@shadowspawn
Copy link
Collaborator Author

shadowspawn commented Dec 22, 2021

(Deleted my comment with code which included multiple changes not all related to this PR.)

@bcoe bcoe changed the title Clean up README examples docs: clean up README examples Dec 28, 2021
@bcoe bcoe merged commit b25f385 into pkgjs:main Dec 28, 2021
@shadowspawn shadowspawn deleted the feature/examples-without-repeated-options branch December 28, 2021 00:34
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.

3 participants