Skip to content

bpo-35603: Add a note on difflib table header interpreted as HTML - #11439

Merged
JulienPalard merged 3 commits into
python:masterfrom
tirkarthi:bpo35603-doc-fix
Sep 11, 2019
Merged

bpo-35603: Add a note on difflib table header interpreted as HTML#11439
JulienPalard merged 3 commits into
python:masterfrom
tirkarthi:bpo35603-doc-fix

Conversation

@tirkarthi

@tirkarthi tirkarthi commented Jan 5, 2019 •
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

This adds a doc note on the difflib make_file output. Wording suggestions are welcome.

Output as note :

screen shot 2019-01-06 at 1 11 54 am

Output as warning :

screen shot 2019-01-06 at 1 12 38 am

https://bugs.python.org/issue35603

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting review labels Jan 5, 2019
@epicfaace

epicfaace commented Jan 7, 2019 •
edited
Loading

Copy link
Copy Markdown
Contributor

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.

@tirkarthi

tirkarthi commented Jan 7, 2019

Copy link
Copy Markdown
Member Author

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.

@tirkarthi

tirkarthi commented Jan 8, 2019

Copy link
Copy Markdown
Member Author

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!

serhiy-storchaka
serhiy-storchaka reviewed Jan 8, 2019
View reviewed changes

@serhiy-storchaka serhiy-storchaka left a comment

Copy link
Copy Markdown
Member

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.

@tirkarthi

tirkarthi commented Jan 8, 2019

Copy link
Copy Markdown
Member Author

@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 :

screen shot 2019-01-08 at 5 36 43 pm

@csabella
csabella requested a review from serhiy-storchaka June 5, 2019 16:26
@JulienPalard
JulienPalard merged commit c78dae8 into python:master Sep 11, 2019
@miss-islington

miss-islington commented Sep 11, 2019

Copy link
Copy Markdown
Contributor

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 Sep 11, 2019
@tirkarthi @miss-islington
bpo-35603: Add a note on difflib table header interpreted as HTML (py…
8d47e58 
…thonGH-11439)

(cherry picked from commit c78dae8)

Co-authored-by: Xtreak <[email protected]>
@bedevere-bot

bedevere-bot commented Sep 11, 2019

Copy link
Copy Markdown

GH-15922 is a backport of this pull request to the 3.8 branch.

miss-islington added a commit that referenced this pull request Sep 11, 2019
@miss-islington @tirkarthi
bpo-35603: Add a note on difflib table header interpreted as HTML (GH…
44e36e8 
…-11439)

(cherry picked from commit c78dae8)

Co-authored-by: Xtreak <[email protected]>
DinoV pushed a commit to DinoV/cpython that referenced this pull request Sep 12, 2019
@tirkarthi @DinoV
bpo-35603: Add a note on difflib table header interpreted as HTML (py…
a94555c 
…thonGH-11439)
websurfer5 pushed a commit to websurfer5/cpython that referenced this pull request Jul 20, 2020
@tirkarthi @websurfer5
bpo-35603: Add a note on difflib table header interpreted as HTML (py…
7e37e3e 
…thonGH-11439)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchaka serhiy-storchaka Awaiting requested review from serhiy-storchaka

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@tirkarthi @epicfaace @miss-islington @bedevere-bot @serhiy-storchaka @JulienPalard @the-knights-who-say-ni