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

CLI Changes Sub-PR: Documentation #592

Merged
merged 8 commits into from Aug 14, 2023

Conversation

Xophmeister
Copy link
Member

@Xophmeister Xophmeister commented Aug 4, 2023

This forms a part of PR #583 and must not be merged into main alone. It is only the implementation of isolated functionality -- and thus not expected to necessarily pass the CI checks -- to split up the work into logical chunks.

NOTE This PR's code is mutually exclusive from that in #591 and #593, but the functionality in those PRs motivate the changes made here. It would therefore make sense to merge this one after those have been approved and merged.

@Xophmeister Xophmeister mentioned this pull request Aug 4, 2023
26 tasks
@Xophmeister Xophmeister merged commit f04d3fb into chris/cli-changes Aug 14, 2023
2 of 4 checks passed
@Xophmeister Xophmeister deleted the chris/new-cli/documentation branch August 14, 2023 08:44
Xophmeister added a commit that referenced this pull request Aug 14, 2023
* Update CHANGELOG

* Update README

* Update script that checks that the README correlates with --help

* Make README/CLI checking script a bit clearer

* Updated usage with new collation modes

* Documented configuration collation

* Update example call sites to new CLI

* Added a migration guide for the CLI changes to the CHANGELOG
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.

None yet

2 participants