[Python-Dev] Re: Inline links in Misc/NEWS entries

[Kyle Stanley]

> the talk I gave last month at PyOhio (
https://www.pyohio.org/2019/presentations/137)

> Right now I have the slides up as a view-only share in my Google Drive (
bit.ly/bskinn-pyohio2019-intersphinx). Perhaps it would be useful to link
to them? Or, to host a PDF someplace more permanent, and link to that?

Thanks for the links, I'll definitely take a look through them for myself
to see if I can gain any additional information. I've been using Sphinx and
reST a decent amount recently, but I'm definitely not the most experienced.

Also, there's a PR open for providing netlify previews for CPython PRs:
https://github.com/python/cpython/pull/15288. From what I understand, we'll
be recommending for PR authors to use that to preview documentation
changes, particularly when any rich formatting is involved.

> - [ ] And a *link*/"reference" from the "extensive cross-references"
paragraph of https://www.sphinx-doc.org/en/master/ to the cross-referencing
docs

We currently link to the Sphinx docs in the dedicated section, "Additional
Markup Constructs":
https://devguide.python.org/documenting/#additional-markup-constructs. The
section in the PR was only meant to provide a very brief summary for using
Sphinx in NEWS entries. I included a link to the "Additional Markup
Constructs" section for readers looking for additional information.

It might be worthwhile to create a new subsection for links to external
resources and guides. If accepted, the best location in the devguide would
probably be 7.4.12 (assuming that no other sections are added in the
meantime). However, that proposal would have to be in it's own topic,
rather than in this one.


On Mon, Aug 19, 2019 at 12:33 PM Wes Turner  wrote:

> - [ ] A page or section in the Sphinx docs would be helpful for many, I
> think
>
> https://github.com/sphinx-doc/sphinx/tree/master/doc
>
> ``__
>
>
> .. index:: Implicit reference
> .. _implicit-reference:
>
> Implicit ref
> ---
>
> `implicit ref`_
>
> `anchor text `_
>
> `implicit-reference`_
>
> `implicit reference`_
>
> :func:`modname.funcname`
>
> :meth:`modname.Classname.methname`
>
> :class:`modname.Classname`
>
> And, FWIW:
>
> :cite:`cpython37`
>
> .. bibliography:: references.bib
>
> References.bib
> --
> .. code:: latex
>
> @techreport{cpython37,
> title="Python 3.7 Documentation",
> author="Python Software Foundation",
> year=1999,
> howpublished = "\url{https://docs.python.org/3.7/};,
> }
>
>
>
> - [ ] And/Or examples on the roles docs page
> https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role
>
> - [ ] And a *link*/"reference" from the "extensive cross-references"
> paragraph of https://www.sphinx-doc.org/en/master/ to the
> cross-referencing docs
>
> - [ ] And how to do parenthetical citations of / reference CPython with
> e.g. bibtex [with the `.. bibliography::` directive and :cite:`refkey` role
> from sphinxcontrib-bibtex]
>
> There are lots of great Sphinx primers; awesome-sphinxdoc could link to
> them to help everyone:
> https://github.com/yoloseem/awesome-sphinxdoc
>
> On Monday, August 19, 2019,  wrote:
>
>> Citing from the current (19 Aug 2019) version of this PR (
>> https://github.com/python/devguide/pull/525/files#diff-50cb76bbe8ae3fcd4170dc6e8d9d6b3fR225-R226
>> ):
>>
>> > Before using any Sphinx roles, ensure that a corresponding entry exists
>> within the documentation.
>>
>> At the risk of crass self-promotion, the talk I gave last month at PyOhio
>> (https://www.pyohio.org/2019/presentations/137) provides step-by-step
>> instructions for how to find the information needed to craft a working
>> Sphinx cross-reference, along with some of the tooling that's available.
>>
>> Right now I have the slides up as a view-only share in my Google Drive (
>> bit.ly/bskinn-pyohio2019-intersphinx). Perhaps it would be useful to
>> link to them? Or, to host a PDF someplace more permanent, and link to that?
>> ___
>> Python-Dev mailing list -- python-dev@python.org
>> To unsubscribe send an email to python-dev-le...@python.org
>> https://mail.python.org/mailman3/lists/python-dev.python.org/
>> Message archived at
>> https://mail.python.org/archives/list/python-dev@python.org/message/IK5XP7CPZDF2FSFG55JRKXHEXNTOMUTB/
>>
> ___
> Python-Dev mailing list -- python-dev@python.org
> To unsubscribe send an email to python-dev-le...@python.org
> https://mail.python.org/mailman3/lists/python-dev.python.org/
> Message archived at
> https://mail.python.org/archives/list/python-dev@python.org/message/SSMNWK7YF6WRT2NO4C2IQ6PGD2XVJOZT/
>
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 

[Python-Dev] Re: Missing license for file Modules/ossaudiodev.c

[Jeff Allen]

On 19/08/2019 21:30, Terry Reedy wrote:

On 8/19/2019 3:19 PM, Jeff Allen wrote:
When one signs up to contribute code to the PSF, one is asked to 
write on  contributed software that it has been "Licensed to the PSF 
under a Contributor Agreement" (see 
https://www.python.org/psf/contrib/contrib-form/). The XXX comment 
may signal an intention to return and insert such words.
The form says specifically "adjacent to Contributor's valid copyright 
notice".  *If* the contribution comes with a separate explicit 
copyright notice (most do not), then it should be followed by the 
contribution notice.
Ah, ok. I hadn't read it that way: rather a request to add both. That is 
useful, thanks: occasionally, I have to guide contributors to Jython, 
who sign the same form.


Jeff

___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/3CE5UQCOLKJ2GI3EZPBIGDJAECI6J77K/

[Python-Dev] Re: Missing license for file Modules/ossaudiodev.c

[Ivan Pozdeev via Python-Dev]

On 19.08.2019 23:30, Terry Reedy wrote:

On 8/19/2019 3:19 PM, Jeff Allen wrote:

This is undoubtedly the right answer for someone wanting to *use* code *from* 
CPython.

When one signs up to contribute code to the PSF, one is asked to write on  contributed software that it has been "Licensed to the PSF 
under a Contributor Agreement" (see https://www.python.org/psf/contrib/contrib-form/). The XXX comment may signal an intention to return 
and insert such words.


The form says specifically "adjacent to Contributor's valid copyright notice".  *If* the contribution comes with a separate explicit 
copyright notice (most do not), then it should be followed by the contribution notice.


ossaudiodev.c has 3 copyright notices, the last being by PSF in 2002, long before he current Contributor Agreement, and apparently never 
challenged.  Hence Guido's claim that the module is covered by the general PSF license.



The text has "All rights reserved" in all three lines which is _not_ a 
copyright notice but a license grant.
It's those license grants, including PSF's, that are untrue.

Compare with e.g. Tools/msi/bundle/bootstrap/pch.h and Modules/_hashopenssl.c in which a copyright notice correctly comes bare and is 
followed by a license grant compatible with PSFLA.


--
Regards,
Ivan
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/NX2IJXGR4S6N6X6EW2J2Z3U3XGOYBKVY/

[Python-Dev] Re: Missing license for file Modules/ossaudiodev.c

[Terry Reedy]

On 8/19/2019 3:19 PM, Jeff Allen wrote:
This is undoubtedly the right answer for someone wanting to *use* code 
*from* CPython.


When one signs up to contribute code to the PSF, one is asked to write 
on  contributed software that it has been "Licensed to the PSF under a 
Contributor Agreement" (see 
https://www.python.org/psf/contrib/contrib-form/). The XXX comment may 
signal an intention to return and insert such words.


The form says specifically "adjacent to Contributor's valid copyright 
notice".  *If* the contribution comes with a separate explicit copyright 
notice (most do not), then it should be followed by the contribution notice.


ossaudiodev.c has 3 copyright notices, the last being by PSF in 2002, 
long before he current Contributor Agreement, and apparently never 
challenged.  Hence Guido's claim that the module is covered by the 
general PSF license.


--
Terry Jan Reedy

___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/A3F45XVMPHH72O6OPOTFLVFR3EUG22SZ/

[Python-Dev] Re: Missing license for file Modules/ossaudiodev.c

[Jeff Allen]

This is undoubtedly the right answer for someone wanting to *use* code 
*from* CPython.


When one signs up to contribute code to the PSF, one is asked to write 
on  contributed software that it has been "Licensed to the PSF under a 
Contributor Agreement" (see 
https://www.python.org/psf/contrib/contrib-form/). The XXX comment may 
signal an intention to return and insert such words.


You cannot find many instances of those words in CPython (and Jython is 
worse). Many of the files pre-date the fomula, most contributions are a 
change to existing code, and adding it later to someone else's work 
doesn't feel right. (The situation is clear for pristene code.) I have 
wondered if it's an issue.


Jeff

Jeff Allen

On 19/08/2019 15:35, Guido van Rossum wrote:

The LICENSE file at the top level of the repo covers everything.

On Mon, Aug 19, 2019 at 7:33 AM mihaela olteanu via Python-Dev 
mailto:python-dev@python.org>> wrote:


Hello,

Could you please let me know what is the license for the file
Modules/ossaudiodev.c ?
Inside the description there is a statement :"XXX need a license
statement" which creates some confusion.
Can we simply disregard that statement as for the other .c files
which do not have such statements?
Please note that we need this information for our OSS clearance
report.

Thank you,
    Mihaela
___
Python-Dev mailing list -- python-dev@python.org

To unsubscribe send an email to python-dev-le...@python.org

https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at

https://mail.python.org/archives/list/python-dev@python.org/message/BOG2EPE77PZPM52JCXMPZVYQRNL2XXN7/



--
--Guido van Rossum (python.org/~guido )
/Pronouns: he/him/his //(why is my pronoun here?)/ 



___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/O2VUG4CFGAKQGMVBLEOEFKZCJD3KSIAI/
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/G6KTZD375L4M3W7HMJGBPBP3XN7VPAOT/

[Python-Dev] Re: Inline links in Misc/NEWS entries

[Wes Turner]

- [ ] A page or section in the Sphinx docs would be helpful for many, I
think

https://github.com/sphinx-doc/sphinx/tree/master/doc

``__


.. index:: Implicit reference
.. _implicit-reference:

Implicit ref
---

`implicit ref`_

`anchor text `_

`implicit-reference`_

`implicit reference`_

:func:`modname.funcname`

:meth:`modname.Classname.methname`

:class:`modname.Classname`

And, FWIW:

:cite:`cpython37`

.. bibliography:: references.bib

References.bib
--
.. code:: latex

@techreport{cpython37,
title="Python 3.7 Documentation",
author="Python Software Foundation",
year=1999,
howpublished = "\url{https://docs.python.org/3.7/};,
}



- [ ] And/Or examples on the roles docs page
https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#ref-role

- [ ] And a *link*/"reference" from the "extensive cross-references"
paragraph of https://www.sphinx-doc.org/en/master/ to the cross-referencing
docs

- [ ] And how to do parenthetical citations of / reference CPython with
e.g. bibtex [with the `.. bibliography::` directive and :cite:`refkey` role
from sphinxcontrib-bibtex]

There are lots of great Sphinx primers; awesome-sphinxdoc could link to
them to help everyone:
https://github.com/yoloseem/awesome-sphinxdoc

On Monday, August 19, 2019,  wrote:

> Citing from the current (19 Aug 2019) version of this PR (
> https://github.com/python/devguide/pull/525/files#diff-
> 50cb76bbe8ae3fcd4170dc6e8d9d6b3fR225-R226):
>
> > Before using any Sphinx roles, ensure that a corresponding entry exists
> within the documentation.
>
> At the risk of crass self-promotion, the talk I gave last month at PyOhio (
> https://www.pyohio.org/2019/presentations/137) provides step-by-step
> instructions for how to find the information needed to craft a working
> Sphinx cross-reference, along with some of the tooling that's available.
>
> Right now I have the slides up as a view-only share in my Google Drive (
> bit.ly/bskinn-pyohio2019-intersphinx). Perhaps it would be useful to link
> to them? Or, to host a PDF someplace more permanent, and link to that?
> ___
> Python-Dev mailing list -- python-dev@python.org
> To unsubscribe send an email to python-dev-le...@python.org
> https://mail.python.org/mailman3/lists/python-dev.python.org/
> Message archived at https://mail.python.org/archives/list/python-dev@
> python.org/message/IK5XP7CPZDF2FSFG55JRKXHEXNTOMUTB/
>
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/SSMNWK7YF6WRT2NO4C2IQ6PGD2XVJOZT/

[Python-Dev] Re: Missing license for file Modules/ossaudiodev.c

[Guido van Rossum]

The LICENSE file at the top level of the repo covers everything.

On Mon, Aug 19, 2019 at 7:33 AM mihaela olteanu via Python-Dev <
python-dev@python.org> wrote:

> Hello,
>
> Could you please let me know what is the license for the file 
> Modules/ossaudiodev.c
> ?
> Inside the description there is a statement :"XXX need a license
> statement" which creates some confusion.
> Can we simply disregard that statement as for the other .c files which do
> not have such statements?
> Please note that we need this information for our OSS clearance report.
>
> Thank you,
> Mihaela
> ___
> Python-Dev mailing list -- python-dev@python.org
> To unsubscribe send an email to python-dev-le...@python.org
> https://mail.python.org/mailman3/lists/python-dev.python.org/
> Message archived at
> https://mail.python.org/archives/list/python-dev@python.org/message/BOG2EPE77PZPM52JCXMPZVYQRNL2XXN7/
>


-- 
--Guido van Rossum (python.org/~guido)
*Pronouns: he/him/his **(why is my pronoun here?)*

___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/O2VUG4CFGAKQGMVBLEOEFKZCJD3KSIAI/

[Python-Dev] Missing license for file Modules/ossaudiodev.c

[mihaela olteanu via Python-Dev]

Hello,
Could you please let me know what is the license for the file 
Modules/ossaudiodev.c ?Inside the description there is a statement :"XXX need a 
license statement" which creates some confusion.Can we simply disregard that 
statement as for the other .c files which do not have such statements?Please 
note that we need this information for our OSS clearance report.

Thank you,    Mihaela
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/BOG2EPE77PZPM52JCXMPZVYQRNL2XXN7/

[Python-Dev] Re: Inline links in Misc/NEWS entries

[brian . skinn]

Citing from the current (19 Aug 2019) version of this PR 
(https://github.com/python/devguide/pull/525/files#diff-50cb76bbe8ae3fcd4170dc6e8d9d6b3fR225-R226):

> Before using any Sphinx roles, ensure that a corresponding entry exists 
> within the documentation.

At the risk of crass self-promotion, the talk I gave last month at PyOhio 
(https://www.pyohio.org/2019/presentations/137) provides step-by-step 
instructions for how to find the information needed to craft a working Sphinx 
cross-reference, along with some of the tooling that's available.

Right now I have the slides up as a view-only share in my Google Drive 
(bit.ly/bskinn-pyohio2019-intersphinx). Perhaps it would be useful to link to 
them? Or, to host a PDF someplace more permanent, and link to that?
___
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-le...@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at 
https://mail.python.org/archives/list/python-dev@python.org/message/IK5XP7CPZDF2FSFG55JRKXHEXNTOMUTB/