Skip to content

Minor documentation edits #38

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

Merged
merged 3 commits into from
Sep 6, 2021
Merged

Minor documentation edits #38

merged 3 commits into from
Sep 6, 2021

Conversation

rlskoeser
Copy link
Contributor

As I was working through the documentation I made corrections for a few minor problems:

  • duplicate help text for one of the command line script arguments in both readme and script
  • extra > in the sample html string in the stdin example
  • annotation rule example assumes that the user has checked out the repository and not installed via pip/easy_install; I suggested a way to revise it to make it easier to follow

Instructions are written as if the user has the repository checked out, but preceding instructions use pip install or easy_install
@AlbertWeichselbraun
Copy link
Contributor

Thank you, @rlskoeser - this looks great.

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