Improved Quality of Python Snippets, fixed issue with CONTRIBUTING.md #193
Conversation
This file contains 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
Renamed from `truncate-string.py` to `truncate.py`
Replaced "..." with ellipses("…") to only use one character
Implemented toggle for the `suffix` "…" on string with default of `True`
Added type hints
…tter functional representation Renamed `convert-string-to-ascii.md` to `convert-string-to-unicode.md` Replaced ASCII with Unicode Kept `ascii` tag as it is a subset of unicode and to minimize search errors Fixed issue dostonnabotov#192
Added a `not` on line 68 in "Does that snippet have a real, and practical use case ?" to prevent useless snippets from being acceptable and useful snippets from being denied.
recovered old attribution in the python snippet`truncate` to axorax and added the contributors tag.
MinerMinerMods
requested review from
psychlone77,
saminjay and
Mathys-Gasnier
as code owners
majvax
reviewed
Jan 5, 2025
There was a problem hiding this comment.
Hey, thanks for your contribution ! 🙌 However there are a few issues that need to be addressed to align with the repository's standards
-
PEP 8 Compliance
Please ensure your code follows the PEP 8 standard by using 4 spaces for indentation instead of tabs. This is important for consistency and readability across the repository. -
Horizontal Ellipsis (…) in truncate Function
You used a horizontal ellipsis (…) instead of the standard "..." in your truncate function. Please stick to "..." for consistency and to avoid potential issues with encoding or readability.
Please make these changes so we could accept your snippets.
removed Tab
Replaced "…" with "..." Updated Description to match
Ready for merge to parent repo
|
Conformed to PEP 8 |
majvax
requested changes
Jan 5, 2025
followed change request
Mathys-Gasnier
requested changes
Jan 5, 2025
2nd integration
Mathys-Gasnier
approved these changes
Jan 6, 2025
majvax
approved these changes
Jan 6, 2025
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.
Description
Made Changes to Python snippets
truncate-stringtotruncateremove-specific-characterstoremove-charactersconvert-string-to-asciitoconvert-string-to-unicodetruncatesuffix"…" on string with default ofTrueintruncateconvert-string-to-unicodeasciitag as it is a subset of unicode and to minimize search errors inconvert-string-to-unicodeMade Changes to
CONTRIBUTING.mdnoton line 68 in "Does that snippet have a real, and practical use case ?" to prevent useless snippets from being acceptable and useful snippets from being denied.Type of Change
Improved Clarity on the acceptance criteria
Checklist
Related Issues
#192
Closes #
#192
Additional Context
Added type-hints to python snippets, fixed a semantic error in
CONTRIBUTING.md, added functionality to opt out of the ellipsis intruncate.py, changedconvert-string-to-asciito better reflect function.