[issue42710] Viewing pydoc API documentation

2020-12-21 Thread Faris Chugthai


New submission from Faris Chugthai :

I'm sure that this has been observed before, but I was unable to find the 
original issue where this was discussed so I'm going to apologize in advance 
for what is probably a duplicate issue.

But why is there no documentation available on the classes and functions 
available in the pydoc module?

There are a large number of well documented classes, methods and functions and 
I could easily imagine legitimate motivations to want to import some of the 
functionality provided and use it in a project.

No information on the 2000 lines of code in pydoc.py are provided at 
https://docs.python.org/3/library/pydoc.html

Running:

`python -m pydoc -w pydoc`

Generates a similarly sparse file.

In addition, running in the interactive interpreter:

>>> help(pydoc)

shows almost no real information. I'm genuinely unsure of why this happens. 
Even if this is an intentional design decision for how the Helper class is 
supposed to work, why isn't there corresponding information for the different 
classes at `Doc/library/pydoc.rst`?

Searching for something like `pydoc.TextRepr` in the search bar of 
docs.python.org doesn't return anything at all.

Sorry if there's something horrifically obvious I'm missing here guys but I'd 
appreciate any clarification on this matter.

--
assignee: docs@python
components: Documentation
messages: 383570
nosy: Faris Chugthai, docs@python
priority: normal
severity: normal
status: open
title: Viewing pydoc API documentation

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



[issue41253] unittest -h shows a flag -s but it doesn't work

2020-07-08 Thread Faris Chugthai


New submission from Faris Chugthai :

I'm not 100% sure what's happening here but running:

`python -m unittest -h`

shows a flag `-s` as does

`python -m unittest discover -h`.

When run as:

`python -m unittest discover -s test`

the command runs correctly but when run as

`python -m unittest -s test`

the command fails.

```sh

$ python -m unittest -s test  
  
usage: python -m unittest [-h] [-v] [-q] [--locals] [-f]
[-c] [-b] [-k TESTNAMEPATTERNS]   [tests 
[tests ...]

   
python -m unittest: error: unrecognized arguments: -s

```

Which I believe to be a bug as the help generated by the discover subcommand 
indicates that the flag -s should be recognized.

--
components: Tests
messages: 373372
nosy: Faris Chugthai
priority: normal
severity: normal
status: open
title: unittest -h shows a flag -s but it doesn't work
type: behavior
versions: Python 3.8

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



[issue41227] minor typo in asyncio transport protocol

2020-07-06 Thread Faris Chugthai


New submission from Faris Chugthai :

The penultimate sentence in asyncio transport.

> The subprocess is created by th loop.subprocess_exec() method:

Should be `created by the`.

The sentence can be seen here:

https://docs.python.org/3.10/library/asyncio-protocol.html?highlight=call_soon#loop-subprocess-exec-and-subprocessprotocol

--
assignee: docs@python
components: Documentation, asyncio
messages: 373204
nosy: Faris Chugthai, asvetlov, docs@python, yselivanov
priority: normal
severity: normal
status: open
title: minor typo in asyncio transport protocol
versions: Python 3.10, Python 3.8, Python 3.9

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