Skip to content

fix(docs): Fix README.md pypi rendering. #73

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.

Sign up for GitHub

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
OlegZv merged 1 commit into from
Aug 3, 2025
Merged

fix(docs): Fix README.md pypi rendering. #73

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,4 +179,4 @@ An APIRouter will be created for each version, with the URL prefix defined by th

If you need to [mount static files](https://fastapi.tiangolo.com/tutorial/static-files/), you'll have to add those to
your FastAPI app **after** instantiating Versionizer. See the [Static file mount](https://github.com/alexschimpf/fastapi-versionizer/tree/main/examples/with_static_file_mount.py)
example for more details.
example for more details.
Copy link
Owner

@alexschimpf alexschimpf Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the diff, I can't tell what you even changed here. Just curious.

Copy link
Collaborator Author

@OlegZv OlegZv Aug 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adds a new line 🤷
Github is usually pretty good at showing "you forgot a new line" in PRs, but for some reason, it doesn't show the diff nicely.

I tested adding a new line in my test pypi project here: https://test.pypi.org/project/olegs-readme-test/
You can see that in the previous version I pushed it as is and it rendered similarly to how it is with 4.0.2 right now: https://test.pypi.org/project/olegs-readme-test/4.0.2/

The only difference was the extra new line in the README.md.