[issue42571] [docs] add links to Glossary#parameter in libraries

[Frederic Gagnon]

Frederic Gagnon  added the comment:

The information could be added to 
https://docs.python.org/3/faq/library.html#general-library-questions , leading 
to links to where to find information about the library's syntax

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue42571] [docs] add links to Glossary#parameter in libraries

[Frederic Gagnon]

Frederic Gagnon  added the comment:

I didn't know if that "*" was part of python, or just specific to the 
documentation.

I started by just looking around the page (header, section on the left and 
footer) for some kind of link pointing to how to interpret the documentation.

Not finding anything, I went up the tree (first to 
https://docs.python.org/3/library/index.html , then to 
https://docs.python.org/3/index.html ). I then went to the FAQ ( 
https://docs.python.org/3/faq/index.html ).
(Little did I know, the answer was in Glossary...)

Not finding any answer there, I tried googling it (simply starting with "python 
*"), but since * is interpreted as a wildcard, my searches only gave broad 
results about "python".

I then asked a friend who pointed me to 
https://stackoverflow.com/questions/51362773/what-does-mean-as-a-parameter-in-python

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue42571] [docs] add links to Glossary#parameter in libraries

[Éric Araujo]

Éric Araujo  added the comment:

I don’t think every function signature should have links when using `*`, 
`*args` or `**kwargs`.

Is there another page that we could improve?
What did you search for when you wanted to understand what it means?

Possible candidates: tutorial page about functions; language reference about 
functions; others?

--
nosy: +eric.araujo

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue42571] [docs] add links to Glossary#parameter in libraries

[Frederic Gagnon]

New submission from Frederic Gagnon :

Could be helpful to make it so that, in libraries, / * * and **  
(i.e. positional-only, keyword-only, var-positional and var-keyword indicators) 
link to https://docs.python.org/3/glossary.html#term-parameter

This come from someone relatively new to python that had a somewhat hard time 
understanding what the ", *," stood for in 
https://docs.python.org/3/library/glob.html#glob.glob

--
assignee: docs@python
components: Documentation
messages: 382530
nosy: docs@python, fredg1
priority: normal
severity: normal
status: open
title: [docs] add links to Glossary#parameter in libraries
type: enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com