Skip to content

Update README.rst#617

Merged
foarsitter merged 1 commit intomasterfrom
readme-update
May 14, 2024
Merged

Update README.rst#617
foarsitter merged 1 commit intomasterfrom
readme-update

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
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