Re: How to find any documentation for smbus?

Chris Green wrote at 2023-10-28 17:08 +0100: >I am using the python3 smbus module, but it's hard work because of the >lack of documentation. Web searches confirm that the documentation is >somewhat thin! > >If you do the obvious this is what you get:- > >>>> im

Re: How to find any documentation for smbus?

Dan Purgert wrote: > On 2023-10-28, Chris Green wrote: > > I am using the python3 smbus module, but it's hard work because of the > > lack of documentation. Web searches confirm that the documentation is > > somewhat thin! > > > > The SMBus spec is available f

Re: How to find any documentation for smbus?

Il Sat, 28 Oct 2023 17:08:00 +0100, Chris Green ha scritto: > I am using the python3 smbus module, but it's hard work because of the > lack of documentation. Web searches confirm that the documentation is > somewhat thin! > > If you do the obvious this is what you get:- >

Re: How to find any documentation for smbus?

km wrote: > Il Sat, 28 Oct 2023 17:08:00 +0100, Chris Green ha scritto: > > > I am using the python3 smbus module, but it's hard work because of the > > lack of documentation. Web searches confirm that the documentation is > > somewhat thin! > > > > If you

How to find any documentation for smbus?

I am using the python3 smbus module, but it's hard work because of the lack of documentation. Web searches confirm that the documentation is somewhat thin! If you do the obvious this is what you get:- >>> import smbus >>> dir (smbus) ['SMBus', '__doc__', '__fi

Re: Finding good documentation for gpiod

E > On 3 Sep 2023, at 22:49, Chris Green via Python-list > wrote: > > Mostly I am managing to get things to work as I want but better > documentation of gpiod would be a great help. Ask the author? https://github.com/aswild/python-gpiod Maybe read the source code for hints?

Finding good documentation for gpiod

I am using the gpiod package for manipulating GPIO inputs/outputs on a Beaglebone Black SBC (like a Raspberry Pi but with more flexible I/O). Mostly I am managing to get things to work as I want but better documentation of gpiod would be a great help. For example, when one has found an I/O pin

Re: Generating documentation with Sphinx

def construct_response(exit_code: int, message: str) -> Response: >> """ >> Construct a Flask-suitable response >> >> :param exit_code: 0 or something else >> :param message: something useful >> :return: a Flask-suitable response >> """ >> >> >> @app.route(f"/{version}/",

Re: Generating documentation with Sphinx

And I can answer my own Question 2: :func:`my_project.main_application.construct_response` On Mon, Aug 28, 2023 at 1:39 PM Jason Friedman wrote: > def construct_response(exit_code: int, message: str) -> Response: >> """ >> Construct a Flask-suitable response >> >> :param exit_code:

Re: Generating documentation with Sphinx

> > def construct_response(exit_code: int, message: str) -> Response: > """ > Construct a Flask-suitable response > > :param exit_code: 0 or something else > :param message: something useful > :return: a Flask-suitable response > """ > > > @app.route(f"/{version}/",

Generating documentation with Sphinx

I have two questions, please (this is after reading https://docs.readthedocs.io/en/stable/guides/cross-referencing-with-sphinx.html#automatically-label-sections ). This is my project structure: my_project api stuff1.py stuff2.py lib stuff3.py stuff4.py main_application.py

Re: file.read Method Documentation (Python 2.7.10)

On Thu, 12 Jan 2023 at 21:25, Stephen Tucker wrote: > > Chris, > > Thanks for this clarification. > > I have not found documentation that disagrees with you. I simply observe that > the documentation that I have alluded to earlier in this chain (section 5.9 > File Objec

Re: file.read Method Documentation (Python 2.7.10)

Chris, Thanks for this clarification. I have not found documentation that disagrees with you. I simply observe that the documentation that I have alluded to earlier in this chain (section 5.9 File Objects) could have been made clearer by the addition of a note along the lines that the behaviour

Re: file.read Method Documentation (Python 2.7.10)

Chris Angelico schreef op 11/01/2023 om 18:36: On Thu, 12 Jan 2023 at 04:31, Stephen Tucker wrote: > 1. Create BOM.txt > 2. Input three bytes at once from BOM.txt and print them > 3. Input three bytes one at a time from BOM.txt and print them All of these correctly show that a file, in binary

Re: file.read Method Documentation (Python 2.7.10)

> > >>> myfil = codecs.open ("BOM.txt", mode="rb", encoding="UTF-8") > >>> myBOM_4 = myfil.read (1) > >>> myBOM_4 > u'\ufeff' > A. The attempt at Part 5 actually inputs all three bytes when we ask it to > input just the

Re: file.read Method Documentation (Python 2.7.10)

the program something like this: Input the UTF-8-encoded character as the first "byte"; As expected, after reaching the end of the file, continue supplying an empty string for each of the requested extra bytes. == On Wed, Jan 11, 2023 at 11:00 AM Chris Angelico

Re: file.read Method Documentation (Python 2.7.10)

On Wed, 11 Jan 2023 at 21:31, Stephen Tucker wrote: > > Chris - > > In the Python 2.7.10 documentation, I am referring to section 5. Built-in > Types, subsection 5.9 File Objects. > > In that subsection, I have the following paragraph: > > file.read([size]) >

Re: file.read Method Documentation (Python 2.7.10)

Chris - In the Python 2.7.10 documentation, I am referring to section 5. Built-in Types, subsection 5.9 File Objects. In that subsection, I have the following paragraph: file.read([*size*]) Read at most *size* bytes from the file (less if the read hits EOF before obtaining *size* bytes

Re: file.read Method Documentation (Python 2.7.10)

On Tue, 10 Jan 2023 at 01:36, Stephen Tucker wrote: > > Dear Python-list, > > Yes, I know that Python 2.x is no longer supported. > > I have found that the documentation for this method is misleading when the > file being read is UTF-8-encoded: > >Instead of readi

Re: file.read Method Documentation (Python 2.7.10)

On 09/01/2023 14:34, Stephen Tucker wrote: Dear Python-list, Yes, I know that Python 2.x is no longer supported. I have found that the documentation for this method is misleading when the file being read is UTF-8-encoded: Instead of reading *size* bytes, the method reads *size *UTF-8

file.read Method Documentation (Python 2.7.10)

Dear Python-list, Yes, I know that Python 2.x is no longer supported. I have found that the documentation for this method is misleading when the file being read is UTF-8-encoded: Instead of reading *size* bytes, the method reads *size *UTF-8 byte *sequences*. Has this error been corrected

[issue229651] documentation error in 2.0, section 11.4.2 (httplib example)

Change by admin : -- github: None -> 33773 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401821] xmldomminidom.tex: Documentation for minidom

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217158] String literal documentation is not up to date

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215681] zipfile documentation out of sync with module

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue535450] documentation in CHM format

Change by admin : -- github: None -> 36336 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue505150] mac module documentation inaccuracy.

Change by admin : -- github: None -> 35938 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue529923] re module syntax documentation omission

Change by admin : -- github: None -> 36259 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue494620] pydoc library documentation

Change by admin : -- github: None -> 35776 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue453914] bad example in pickle documentation

Change by admin : -- github: None -> 35024 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue438032] Documentation errors in module "profile"

Change by admin : -- github: None -> 34693 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue470607] HTML version of the Idle "documentation"

Change by admin : -- github: None -> 35317 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue415522] documentation: fnctl 8.12

Change by admin : -- github: None -> 34310 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217195] Broken \ref link in documentation

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215308] codecs base classes need documentation

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue402075] More DOM documentation

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215789] operator module missing documentation

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue502023] Correct LFS compilation documentation

Change by admin : -- github: None -> 35900 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401389] Minor fix in documentation of code module

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue500136] Update ext build documentation

Change by admin : -- github: None -> 35874 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue494007] Py_INCREF(Py_None) in documentation

Change by admin : -- github: None -> 35759 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue495601] Documentation strings should end with a

Change by admin : -- github: None -> 35802 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue497109] 'lambda' documentation in strange place

Change by admin : -- github: None -> 35836 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue494622] pydoc library documentation

Change by admin : -- github: None -> 35777 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue476419] Turtle documentation not included.

Change by admin : -- github: None -> 35427 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401850] Documentation for SAX2

Change by admin : -- github: None -> 33322 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue402075] More DOM documentation

Change by admin : -- github: None -> 33382 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue475049] Slight documentation error in XML DOM

Change by admin : -- github: None -> 35412 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue450803] smtpd.py needs documentation

Change by admin : -- github: None -> 34961 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue463572] Misleading documentation for gettext

Change by admin : -- github: None -> 35218 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue451556] bad tags in HTML documentation

Change by admin : -- github: None -> 34975 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue458447] New httplib lacks documentation

Change by admin : -- github: None -> 35104 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue214296] distutils documentation out of date

Change by admin : -- github: None -> 33099 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue446136] regex documentation

Change by admin : -- github: None -> 34868 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue443788] Small documentation fixes

Change by admin : -- github: None -> 34818 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue429554] PyList_SET_ITEM documentation omission

Change by admin : -- github: None -> 34576 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue423087] A small typo in weakref documentation

Change by admin : -- github: None -> 34487 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue416254] documentation for new imaplib methods

Change by admin : -- github: None -> 34340 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue405410] Documentation Non-MSVC-Compilers

Change by admin : -- github: None -> 34047 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue408798] 5.5 bisect documentation

Change by admin : -- github: None -> 34151 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue232005] Making documentation requires Python 2.0+ (II)

Change by admin : -- github: None -> 33911 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue231725] Making documentation requires Python 2.0+

Change by admin : -- github: None -> 33895 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue231653] compile.py, mentioned in documentation, unaccessible

Change by admin : -- github: None -> 33892 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue227273] Documentation of 'long' function is wrong

Change by admin : -- github: None -> 33655 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue225933] warnings framework documentation

Change by admin : -- github: None -> 33599 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue223616] compiler package needs better documentation.

Change by admin : -- github: None -> 33512 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue221672] Documentation which needs updating to 2.0

Change by admin : -- github: None -> 33449 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217178] Documentation missing for __iadd__, __isub__, etc.

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401850] Documentation for SAX2

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215658] Minor spelling mistakes in tutorial of beta2 documentation

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue222176] Error in rotor module documentation

Change by admin : -- github: None -> 33468 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue214296] distutils documentation out of date

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401840] Minor fix in documentation of calendar module.

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215673] Typo in the documentation (very low priority)

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue210833] linker options documentation (PR#195)

Change by admin : ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue225933] warnings framework documentation

Change by admin : -- github: None -> 33599 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue223616] compiler package needs better documentation.

Change by admin : -- github: None -> 33512 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217195] Broken \ref link in documentation

Change by admin : -- github: None -> 33364 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue222176] Error in rotor module documentation

Change by admin : -- github: None -> 33468 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue221672] Documentation which needs updating to 2.0

Change by admin : -- github: None -> 33449 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217158] String literal documentation is not up to date

Change by admin : -- github: None -> 33361 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401821] xmldomminidom.tex: Documentation for minidom

Change by admin : -- github: None -> 33308 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue217178] Documentation missing for __iadd__, __isub__, etc.

Change by admin : -- github: None -> 33363 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401840] Minor fix in documentation of calendar module.

Change by admin : -- github: None -> 33316 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215673] Typo in the documentation (very low priority)

Change by admin : -- github: None -> 33237 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215658] Minor spelling mistakes in tutorial of beta2 documentation

Change by admin : -- github: None -> 33235 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215789] operator module missing documentation

Change by admin : -- github: None -> 33251 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215308] codecs base classes need documentation

Change by admin : -- github: None -> 33193 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue215681] zipfile documentation out of sync with module

Change by admin : -- github: None -> 33241 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue401389] Minor fix in documentation of code module

Change by admin : -- github: None -> 33026 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue210833] linker options documentation (PR#195)

Change by admin : -- github: None -> 32834 ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue5901] missing meta-info in documentation pdf

Ned Deily added the comment: The problem seems to have been fixed again somewhere in the past. -- nosy: +ned.deily resolution: -> fixed stage: patch review -> resolved status: open -> closed versions: +Python 3.10, Python 3.11, Python 3.9 -Python 3.5, Python 3.6

[issue47234] PEP-484 "numeric tower" approach makes it hard/impossible to specify contracts in documentation

Thomas Fischbacher added the comment: Re AlexWaygood: If these PEP-484 related things were so obvious that they would admit a compact description of the problem in 2-3 lines, these issues would likely have been identified much earlier. We would not be seeing them now, given that Python by

[issue47234] PEP-484 "numeric tower" approach makes it hard/impossible to specify contracts in documentation

Alex Waygood added the comment: Please try to make your messages more concise. -- ___ Python tracker ___ ___ Python-bugs-list

[issue47234] PEP-484 "numeric tower" approach makes it hard/impossible to specify contracts in documentation

Thomas Fischbacher added the comment: This is not a partial duplicate of https://bugs.python.org/issue47121 about math.isfinite(). The problem there is about a specific function on which the documentation may be off - I'll comment separately on that. The problem here

[issue47252] socket.makefile documentation is missing data regarding the 'buffering' parameter

New submission from Alon Menczer : The documentation of the socket.makefile method is missing data regarding the behavior of the `buffering` parameter. -- assignee: docs@python components: Documentation messages: 416943 nosy: alon.menczer, docs@python priority: normal severity: normal

[issue5901] missing meta-info in documentation pdf

Change by C.A.M. Gerlach : -- keywords: +patch nosy: +CAM-Gerlach nosy_count: 5.0 -> 6.0 pull_requests: +30424 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/32386 ___ Python tracker

[issue47234] PEP-484 "numeric tower" approach makes it hard/impossible to specify contracts in documentation

Change by Ken Jin : -- nosy: -kj ___ Python tracker ___ ___ Python-bugs-list mailing list Unsubscribe:

[issue46769] Improve documentation for `typing.TypeVar`

Ken Jin added the comment: New changeset d6a7ee69fb3263450ba47bed9104f4a68a08a9bd by Ken Jin in branch '3.9': [3.9] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32375) https://github.com/python/cpython/commit/d6a7ee69fb3263450ba47bed9104f4a68a08a9bd --

[issue46769] Improve documentation for `typing.TypeVar`

Ken Jin added the comment: New changeset 80af26d25af5568229d31ecb2a8f1bf9702b7791 by Ken Jin in branch '3.10': [3.10] bpo-46769: Fix backticks in typing.rst to appease rstlint (GH-32374) https://github.com/python/cpython/commit/80af26d25af5568229d31ecb2a8f1bf9702b7791 --

  1   2   3   4   5   6   7   8   9   10   >