bpo-35603: Add a note on difflib table header interpreted as HTML by tirkarthi · Pull Request #11439 · python/cpython (original) (raw)
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 andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Conversation7 Commits3 Checks0 Files changed
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
[ Show hidden characters]({{ revealButtonHref }})
I think the warning looks better. Maybe it would be clearer if you said "fromdesc and todesc are interpreted as unescaped HTML"?
Additionally, it may be better to move the warning right after the paragraph describing fromdesc and todesc.
Additionally, it may be better to move the warning right after the paragraph describing fromdesc and todesc.
Thanks for the feedback. From what I have seen in docs notes/warnings are generally grouped and placed at the end of docs for a function/class and I feel it can distract the user from rest of docs for make_file if it's in the middle . I have used notes because I don't know if this is intentional or missed during the initial API which was developed during python 2.7.
I think the warning looks better. Maybe it would be clearer if you said "fromdesc and todesc are interpreted as unescaped HTML"?
Rephrased note as suggested. Thanks!
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it is better to place the note above the versionchanged directive.
@serhiy-storchaka I have placed it above versionchanged . I just checked the docs and there doesn't seem to be any convention over this. Local build screenshot as below :
Thanks @tirkarthi for the PR, and @JulienPalard for merging it 🌮🎉.. I'm working now to backport this PR to: 3.8.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request
miss-islington added a commit that referenced this pull request
(cherry picked from commit c78dae8)
Co-authored-by: Xtreak tir.karthi@gmail.com
DinoV pushed a commit to DinoV/cpython that referenced this pull request
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request
