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

Cleanup of README file #174

Closed
shaido987 opened this issue Jul 8, 2021 · 5 comments
Closed

Cleanup of README file #174

shaido987 opened this issue Jul 8, 2021 · 5 comments

Comments

@shaido987
Copy link
Contributor

The README.md file has some (minor) grammatical and punctuation issues that interrupt the reading flow. Some examples:

  • Missing punctuation (lines, 57, 200, 202, etc.)
  • Unnecessary capitalized words (lines 73, 91, etc.)
  • Additional spaces around commas (e.g., line 96)
  • NumPy, SciPy and Pandas should be properly capitalized as they are names.

For the Python example code in the README, PEP8 recommends not using spaces around the = sign when used to indicate keyword arguments.

The above are all very minor and low priority issues but fixing them can be done without any large effort.

@antoinecarme
Copy link
Owner

@shaido987

Thanks a lot. These changes are of course valuable for PyAF users.

I will review the pull request.

@antoinecarme
Copy link
Owner

Related pull request :

#173

@antoinecarme
Copy link
Owner

@shaido987

I assigned this issue to you. Up to you to close it.

@shaido987
Copy link
Contributor Author

@antoinecarme

Sure, I will close it for now as the PR is merged. If there is anything more in the future I will open up a new issue.

@antoinecarme
Copy link
Owner

Perfect!! Thanks a lot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants