docs: refresh README for 5.0.1 - #305
Merged
Merged
Conversation
- Add missing export-config, export-plugins, json-config commands to the command list and the aprsd -h example (and dump-stats/passcode to the -h example) - Remove AVWXWeatherPlugin, OWMWeatherPlugin, TimeOWMPlugin from the built-in plugin table (no longer in aprsd/plugins) - Fix list-extensions help text in the -h example (see PR #304) - Fix stray 'a' in the docs link sentence - tox -epep8 -> tox -efast8 (env renamed) - Link PLUGINS.md from the built-in plugins section
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation review for the 5.0.1 release. README.md fixes, all verified against the code at master tip:
aprsd -hexample were missing three commands that exist in the CLI:export-config,export-plugins,json-config(verified withaprsd -h). The -h example was also missingdump-statsandpasscode.aprsd/plugins/(discovery in aprsd/utils/package.py:251 scans fortune/notify/ping/time/version/weather only); removed to match currentaprsd list-pluginsoutput.list-extensionshelp text in the -h example now says 'extensions' (matches aprsd/cmds/list_plugins.py after PR fix: list-extensions help text says extensions not plugins #304).tox -epep8->tox -efast8(the ep8 tox env no longer exists; tox.ini defines fast8).Depends on PR #304 for the list-extensions wording in the -h example.