Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 653126 - GLEP 2: "XXX" is an invalid value
Summary: GLEP 2: "XXX" is an invalid value
Status: RESOLVED FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: GLEP Changes (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: GLEP Editors
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-04-14 05:49 UTC by Ulrich Müller
Modified: 2018-04-17 18:52 UTC (History)
2 users (show)

See Also:
Package list:
Runtime testing required: ---


Attachments
glep-0002: Recommend 9999 as number for pre-draft GLEPs. (0001-glep-0002-Recommend-9999-as-number-for-pre-draft-GLE.patch,1.11 KB, patch)
2018-04-14 09:42 UTC, Ulrich Müller
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ulrich Müller gentoo-dev 2018-04-14 05:49:52 UTC
GLEP 2 says in section "How to Use This Template":

- Replace the "GLEP: 2" header with "GLEP: XXX" since you don't yet have
  a GLEP number assignment.

XXX is the Roman numeral for 30, so there is potential for confusion. More importantly, when rendering such a (pre-)draft GLEP with docutils-glep, I get a warning:

$ glep glep-foo.rst >/dev/null
glep-foo.rst:: (WARNING/2) "GLEP" header must contain an integer; "XXX" is an invalid value.

In order to suppress that warning, I suggest that we recommend "9999" instead. (It is unlikely that we'll arrive at that number anytime soon; and if we do, we'll have to update our workflow anyway because of the current 4-digit file name format.)

Note: PEP 1 also recommends using 9999 for drafts: https://www.python.org/dev/peps/pep-0001/#submitting-a-pep
Comment 1 Ulrich Müller gentoo-dev 2018-04-14 09:42:32 UTC
Created attachment 527318 [details, diff]
glep-0002: Recommend 9999 as number for pre-draft GLEPs.
Comment 2 Ulrich Müller gentoo-dev 2018-04-17 18:52:48 UTC
I haven't seen any objections, therefore pushed:

commit 2b2fbd8ae06fb425c6edf6b809224e31bd94c9a1
Author: Ulrich Müller <ulm@gentoo.org>
Date:   Sat Apr 14 11:38:37 2018 +0200

    glep-0002: Recommend 9999 as number for pre-draft GLEPs.
    
    The currently used "XXX" value triggers a warning in docutils-glep.
    
    Closes: https://bugs.gentoo.org/653126