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

Various improvements to the README file #50

Merged
merged 6 commits into from
Aug 11, 2023
Merged

Conversation

diazona
Copy link
Owner

@diazona diazona commented Aug 10, 2023

This PR makes various improvements related to the README file:

  • Fix the filename used in setup.cfg
  • Add a linter for Markdown
  • Remove the unused pytest-checkdocs package
  • Improve formatting and add a bit of text to the README

The metadata was using README.rst, as a relic of this project's origins,
but we actually use a Markdown file so I'm changing it to README.md.
I looked into the source of pytest-checkdocs and found that it only acts
on Restructured Text files, not on Markdown files. Since we use Markdown
for our README (which is also the long description), it's not doing us
any good, and therefore I'm removing it.
I examined a few different Markdown linters that supply pre-commit hooks
to find one that would work for our project. The one by Igor Shubovych
seems to be popular and actively developed, supports configuration, and
offers auto-fixing of some issues, so I think it's a good choice for
this project.
These changes allow the markdownlint-fix pre-commit hook to pass. These
particular errors are apparently not automatically fixable.
This is the typical disclaimer about how the project isn't done yet.
@diazona diazona added the documentation Improvements or additions to documentation label Aug 10, 2023
@diazona diazona added this to the Initial release milestone Aug 10, 2023
@diazona diazona requested a review from sjlongland August 10, 2023 08:27
@diazona diazona enabled auto-merge August 10, 2023 08:27
@diazona diazona merged commit 4ba94bb into main Aug 11, 2023
@diazona diazona deleted the readme-improvements/1/dev branch August 11, 2023 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants