Wrong/missing code formats in datetime documentation #85453

yyyyyyyan · 2020-07-12T05:26:30Z

BPO	41281
Nosy	@ezio-melotti, @merwok, @willingc, @JulienPalard, @yyyyyyyan
PRs	gh-85453: Fix missing/wrong backquotes and role texts in datetime documentation #21447

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2020-07-12.05:26:29.849>
labels = ['type-feature', '3.8', '3.9', '3.10', 'docs']
title = 'Wrong/missing code formats in datetime documentation'
updated_at = <Date 2020-07-12.05:29:56.710>
user = 'https://github.com/yyyyyyyan'

bugs.python.org fields:

activity = <Date 2020-07-12.05:29:56.710>
actor = 'yyyyyyyan'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-07-12.05:26:29.849>
creator = 'yyyyyyyan'
dependencies = []
files = []
hgrepos = []
issue_num = 41281
keywords = ['patch']
message_count = 1.0
messages = ['373547']
nosy_count = 6.0
nosy_names = ['ezio.melotti', 'eric.araujo', 'docs@python', 'willingc', 'mdk', 'yyyyyyyan']
pr_nums = ['21447']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue41281'
versions = ['Python 3.8', 'Python 3.9', 'Python 3.10']

Linked PRs

yyyyyyyan · 2020-07-12T05:26:29Z

The datetime page in the docs is missing a lot of needed backquotes syntax for inline code samples. There are some wrong role links too, due to ambiguity in the text roles.

uatach · 2024-04-18T01:02:46Z

hello @erlend-aasland, I would like to help with this

erlend-aasland · 2024-04-18T13:18:59Z

Great, @uatach, go ahead! Let me know if you have any questions.

erlend-aasland · 2024-04-24T19:43:33Z

In PR #118068, code formatting was removed from many numeric literals; let's follow up with a PR to make that consistent across datetime.rst. The following lines still contain numeric literals marked up with double backticks:

L94
L2564
L2711

erlend-aasland · 2024-04-24T19:45:13Z

Remark by Serhiy #118068 (comment) for L373:

I understand what it means, but it would be nice to explain what does "zero" mean. Is it already explained anywhere?

cpython/Doc/library/datetime.rst

Line 373 in 17947e2

Division by zero raises :exc:`ZeroDivisionError`.

erlend-aasland · 2024-04-24T19:46:42Z

Remark by Serhiy #118068 (comment):

Should not the sentence start with the title case?

cpython/Doc/library/datetime.rst

Lines 347 to 352 in 17947e2

    
           | ``-t1``                        | equivalent to ``timedelta(-t1.days,           | 
        
           |                                | -t1.seconds*, -t1.microseconds)``,            | 
        
           |                                | and to ``t1 * -1``. (1)(4)                    | 
        
           +--------------------------------+-----------------------------------------------+ 
        
           | ``abs(t)``                     | equivalent to ``+t`` when ``t.days >= 0``,    | 
        
           |                                | and to ``-t`` when ``t.days < 0``. (2)        |

Check the whole file and fix up any incorrect capitalisation.

erlend-aasland · 2024-04-24T19:48:30Z

Remark by Serhiy #118068 (comment):

Needed a reference to (3).

cpython/Doc/library/datetime.rst

Lines 328 to 330 in 17947e2

    
           | ``t1 = t2 / f or t1 = t2 / i`` | Delta divided by a float or an int. The result| 
        
           |                                | is rounded to the nearest multiple of         | 
        
           |                                | timedelta.resolution using round-half-to-even.|

…ppets and variables (#118068) Also remove formatting from numeric literals. Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Erlend E. Aasland <erlend@python.org>

…de snippets and variables (pythonGH-118068) Also remove formatting from numeric literals. (cherry picked from commit 809aa9a) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Erlend E. Aasland <erlend@python.org>

ayushman2046 · 2024-07-09T17:03:48Z

Is this issue still open? I would like to contribute.

merwok · 2024-07-09T20:00:27Z

Could the docs editorial board review this?

I am not convinced of the necessity of avoiding timezone or datetime.
Timezone, like filesystem, is a form with a special meaning, now common in normal English to represent the concept.
Things like the current datetime are not common, but they are readily understandable in the context of the python datetime module docs.

willingc · 2024-07-12T09:39:27Z

@python/editorial-board Please review thoughts on moving from timezone in prose docs to time zone. I'm leaning toward @merwok's perspective that the change is not a necessity. Looking for additional perspective on this.

gvanrossum · 2024-07-12T15:34:42Z

@python/editorial-board Please review thoughts on moving from timezone in prose docs to time zone. I'm leaning toward @merwok's perspective that the change is not a necessity. Looking for additional perspective on this.

There are already plenty of places where the docs use "time zone" (when referring to the general concept, not the module or object). I Googled and the consensus seems to be that it's two words.

Regarding "datetime" vs. "date time", neither is correct English. IMO the concept ought to be referred to as "date and time", or could possibly shortened as "date/time". But I'm more open to keeping "datetime" as a form of jargon we're inventing. (Though I don't feel that way about "timezone".)

erlend-aasland · 2024-07-12T22:34:03Z

IMO the concept ought to be referred to as "date and time", [...]

Yes, this is what #118449 proposes.

…rst (#118449)

…etime.rst (pythonGH-118449) (cherry picked from commit 1755df7) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

…tetime.rst (GH-118449) (#121838) (cherry picked from commit 1755df7) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

…etime.rst (python#118449)

…tetime.rst (GH-118449) (#121837) (cherry picked from commit 1755df7) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

…ythonGH-123655) (cherry picked from commit 9aea9c1) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

…H-123655) (#123741) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

…H-123655) (#123740) Co-authored-by: edson duarte <eduarte.uatach@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

Variables and literals are marked up using backticks.

…20702) Variables and literals are marked up using backticks. (cherry picked from commit 2a5cdb2) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

#125490) Variables and literals are marked up using backticks. (cherry picked from commit 2a5cdb2) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

#125491) Variables and literals are marked up using backticks. (cherry picked from commit 2a5cdb2) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

yyyyyyyan mannequin added 3.8 (EOL) end of life 3.9 only security fixes 3.10 only security fixes labels Jul 12, 2020

yyyyyyyan mannequin assigned docspython Jul 12, 2020

yyyyyyyan mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.8 (EOL) end of life 3.9 only security fixes 3.10 only security fixes labels Jul 12, 2020

yyyyyyyan mannequin assigned docspython Jul 12, 2020

yyyyyyyan mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jul 12, 2020

ezio-melotti transferred this issue from another repository Apr 10, 2022

serhiy-storchaka added this to Date and time issues 🕰️ May 21, 2022

bedevere-app bot mentioned this issue Feb 9, 2024

gh-85453: Fix missing/wrong backquotes and role texts in datetime documentation #21447

Closed

erlend-aasland added easy and removed 3.10 only security fixes 3.9 only security fixes 3.8 (EOL) end of life labels Feb 9, 2024

bedevere-app bot mentioned this issue Apr 18, 2024

gh-85453: Adapt datetime.rst to devguide recommendations for code snippets and variables #118068

Merged

bedevere-app bot mentioned this issue Apr 24, 2024

[3.12] gh-85453: Adapt datetime.rst to devguide recommendations for code snippets and variables (GH-118068) #118244

Merged

bedevere-app bot mentioned this issue Jun 18, 2024

gh-85453: Improve variable mark up on datetime.rst #120702

Merged

erlend-aasland pushed a commit that referenced this issue Jul 16, 2024

gh-85453: Fix 'timezone' vs. 'time zone' spelling issues in datetime.…

1755df7

…rst (#118449)

bedevere-app bot mentioned this issue Jul 16, 2024

[3.13] gh-85453: Fix 'timezone' vs. 'time zone' spelling issues in datetime.rst (GH-118449) #121837

Merged

bedevere-app bot mentioned this issue Jul 16, 2024

[3.12] gh-85453: Fix 'timezone' vs. 'time zone' spelling issues in datetime.rst (GH-118449) #121838

Merged

erlend-aasland pushed a commit that referenced this issue Jul 16, 2024

[3.12] gh-85453: Fix 'timezone' vs. 'time zone' spelling issues in da…

52df6c4

…tetime.rst (GH-118449) (#121838) (cherry picked from commit 1755df7) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

estyxx pushed a commit to estyxx/cpython that referenced this issue Jul 17, 2024

pythongh-85453: Fix 'timezone' vs. 'time zone' spelling issues in dat…

c57d062

…etime.rst (python#118449)

erlend-aasland pushed a commit that referenced this issue Jul 23, 2024

[3.13] gh-85453: Fix 'timezone' vs. 'time zone' spelling issues in da…

44ec777

…tetime.rst (GH-118449) (#121837) (cherry picked from commit 1755df7) Co-authored-by: edson duarte <eduarte.uatach@gmail.com>

bedevere-app bot mentioned this issue Sep 3, 2024

gh-85453: Improve instance attributes mark up on datetime.rst #123655

Merged

hugovk added a commit that referenced this issue Sep 5, 2024

gh-85453: Improve instance attributes mark up on datetime.rst (#123655)

9aea9c1

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>

This was referenced Sep 5, 2024

[3.13] gh-85453: Improve instance attributes mark up on datetime.rst (GH-123655) #123740

Merged

[3.12] gh-85453: Improve instance attributes mark up on datetime.rst (GH-123655) #123741

Merged

bedevere-app bot mentioned this issue Sep 11, 2024

gh-85453: Improve class reference links on datetime.rst #123980

Open

erlend-aasland pushed a commit that referenced this issue Oct 14, 2024

gh-85453: Improve variable mark up for datetime.rst (#120702)

2a5cdb2

Variables and literals are marked up using backticks.

bedevere-app bot mentioned this issue Oct 14, 2024

[3.13] gh-85453: Improve variable mark up for datetime.rst (GH-120702) #125490

Merged

bedevere-app bot mentioned this issue Oct 14, 2024

[3.12] gh-85453: Improve variable mark up for datetime.rst (GH-120702) #125491

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Wrong/missing code formats in datetime documentation #85453

Wrong/missing code formats in datetime documentation #85453

yyyyyyyan mannequin commented Jul 12, 2020 •

edited by bedevere-app bot

Loading

yyyyyyyan mannequin commented Jul 12, 2020

Uh oh!

uatach commented Apr 18, 2024

Uh oh!

erlend-aasland commented Apr 18, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

ayushman2046 commented Jul 9, 2024

Uh oh!

merwok commented Jul 9, 2024

Uh oh!

willingc commented Jul 12, 2024

Uh oh!

gvanrossum commented Jul 12, 2024

Uh oh!

erlend-aasland commented Jul 12, 2024

Uh oh!

Uh oh!

Wrong/missing code formats in datetime documentation #85453

Wrong/missing code formats in datetime documentation #85453

Comments

yyyyyyyan mannequin commented Jul 12, 2020 • edited by bedevere-app bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Linked PRs

yyyyyyyan mannequin commented Jul 12, 2020

Uh oh!

uatach commented Apr 18, 2024

Uh oh!

erlend-aasland commented Apr 18, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

erlend-aasland commented Apr 24, 2024

Uh oh!

ayushman2046 commented Jul 9, 2024

Uh oh!

merwok commented Jul 9, 2024

Uh oh!

willingc commented Jul 12, 2024

Uh oh!

gvanrossum commented Jul 12, 2024

Uh oh!

erlend-aasland commented Jul 12, 2024

Uh oh!

yyyyyyyan mannequin commented Jul 12, 2020 •

edited by bedevere-app bot

Loading