> Could a bot be written to suggest upgraded markup for Misc/NEWS entries
as a PR?
Potentially, but to some degree, the decision of whether or not to use the
Sphinx markup should be determined on a case by case basis, rather than
indiscriminately applying the markup to every possible candidate.
Ge
> The ability to effectively use Python-specific Sphinx features in NEWS
entries is a relatively new feature
Ah, I think that would likely explain some of the inconsistent responses
then. I think it would be worthwhile to add an example of using Sphinx and
a brief explanation of when it can be use
Could a bot be written to suggest upgraded markup for Misc/NEWS entries as
a PR?
Most e.g. class, method, and function references probably need ReST markup
AND a more specific fully-qualified reference?
Can class, method, and function lookups be done with the existing Sphinx
API index?
On Tuesda
On Aug 13, 2019, at 15:31, Kyle Stanley wrote:
> > In general, using many Python-specific Sphinx markup entities is fine:
> > browsing though the consolidated blurb files for previous releases (and the
> > resultant changelog html) shows uses of entities like :func: and :class:.
>
> Since it's
> There seems to be some sentiment that it's perfectly fine to exclusively
use plaintext in every news entry.
Oops, that third sentence was a typo, I didn't intend to repeat myself
there.
On Tue, Aug 13, 2019 at 6:31 PM Kyle Stanley wrote:
> > Note that there is an open devguide issue that requ
> Note that there is an open devguide issue that requests improvements in
the description of news entry processing
Good to know, I'll look further into this issue and see if I can help with
it.
> In general, using many Python-specific Sphinx markup entities is fine:
browsing though the consolidat
On Aug 13, 2019, at 00:20, Kyle Stanley wrote:
> On Tue, Aug 13, 2019 at 2:41 AM Mariatta wrote:
> > I would like to understand why some developers dislike including it, even
> > when the reST syntax is provided.
>
> This has something to do with the use of blurb/blurb-it. Both tools
> specif
> * The BODY section should be a single paragraph of English text in ReST
format. It should not use the following ReST markup features:
> * section headers
> * comments
> * directives, citations, or footnotes
> * Any features that require significant line breaks, like lists,
definition lists, quote
