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

Update README.rst #617

Merged
merged 1 commit into from
May 14, 2024
Merged

Update README.rst #617

merged 1 commit into from
May 14, 2024

Conversation

mattseymour
Copy link
Contributor

Update readme.rst

Run tests section does not render on github correctly and this information is available in docs.

Problem

The readme.rst tests section does not render on github and this information is already available in the documentation.

Solution

Removed the section heading and related Run Tests section from readme.rst.

Commandments

  • Write PEP8 compliant code.
  • Cover it with tests.
  • Update CHANGES.rst file to describe the changes, and quote according issue with GH-<issue_number>.
  • Pay attention to backward compatibility, or if it breaks it, explain why.
  • Update documentation (if relevant).

Update readme.rst

Run tests section does not render on github correctly and this information
is available in docs.
@mattseymour mattseymour self-assigned this Apr 22, 2024
@foarsitter
Copy link
Contributor

Looks clumsy indeed, thanks for fixing!

@foarsitter foarsitter merged commit 324ea2b into master May 14, 2024
12 checks passed
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