fix(docs): Fix README.md pypi rendering. #73
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
alexschimpf
reviewed
Aug 3, 2025
| 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. |
Owner
There was a problem hiding this comment.
From the diff, I can't tell what you even changed here. Just curious.
Collaborator
Author
There was a problem hiding this comment.
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.
alexschimpf
approved these changes
Aug 3, 2025
Owner
|
🎉 This PR is included in version 4.0.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I believe this is what it takes for Pypi to render the
long_descriptioncorrectly.