openmano-mpy - MicroPython source and hardware configuration for OpenMano

Age	Commit message (Collapse)	Author
2020-06-05	docs: Fix Sphinx 3.x warnings, and enable warnings-as-errors on build.	David Lechner
	This enables warnings as errors and fixes all current errors, namely: - reference to terms in the glossary must now be explicit (:term:) - method overloads must not be declared as a separate method or must use :noindex: - 2 cases where `` should have been used instead of `
2020-01-12	docs/library: Add / to indicate positional-only args in library docs.	Jason Neal
	Removes the confusion of positional-only arguments which have defaults that look like keyword arguments.
2018-06-27	docs/usocket: Minor fixes to grammar of getaddrinfo.	Damien George

2018-06-27	docs/usocket: getaddrinfo: Describe af/type/proto optional params.	Paul Sokolovsky
	These can be optionally specified, but all ports are expected to be able to accept them, at the very least ignore, though handling of "type" param (SOCK_STREAM vs SOCK_DGRAM) is recommended.
2018-03-05	docs/library/usocket: Make xref to uerrno explicitly a module reference.	Damien George

2017-12-04	docs/library: Add xrefs to "stream" dictionary entry for many modules.	Paul Sokolovsky

2017-10-31	docs/usocket: Document that settimeout() isn't supported by all ports.	Paul Sokolovsky
	And describe an alternative of using uselect.poll().
2017-10-27	docs/usocket: Document inet_ntop(), inet_pton().	Paul Sokolovsky

2017-10-26	docs/usocket: Elaborate descriptions.	Paul Sokolovsky
	Use the "usocket" module name everywhere. Use "MicroPython port" terminology. Suggest to avoid using IPPROTO_* constants in socket() call.
2017-08-28	docs: More xrefs to "MicroPython port" in glossary.	Paul Sokolovsky

2017-08-20	docs/library/usocket: Describe complete information on address formats.	Paul Sokolovsky
	Describe that the only portable way to deal with addresses is by using getaddrinfo(). Describe that some ports may support tuple addresses using "socket" module (vs "usocket" of native MicroPython).
2017-08-20	docs/library/usocket: Move socket.error to its own section.	Paul Sokolovsky
	It's too minor a point to start the module description with it.
2017-07-02	docs/library: Add CPython docs xref to each pertinent module.	Paul Sokolovsky
	Cross-reference text/link is implemented as RST substitution, so easy to consistently.
2017-06-29	docs/{framebuf,usocket}: Use markup adhering to the latest docs conventions.	Paul Sokolovsky

2017-04-09	docs/usocket: Deconditionalize.	Paul Sokolovsky
	Notes on WiPy incompatibilities with the standard socket module API are moved under "Known issues" to its documentation.
2017-01-28	docs/usocket: Dedent Methods section.	Paul Sokolovsky
	This was apparently of an ::only directive which was later removed.
2017-01-28	docs/usocket: Clarify description of various methods.	Paul Sokolovsky

2017-01-28	docs/usocket: Elaborate "Constants" section.	Paul Sokolovsky

2017-01-28	docs/usocket: Clarify exceptions used.	Paul Sokolovsky

2017-01-07	docs/usocket: Clarify that socket timeout raises OSError exception.	Paul Sokolovsky

2016-11-14	docs: Remove references to readall() and update stream read() docs.	Damien George

2016-06-26	docs/library: Fix typo in docs for usocket.listen().	Martin Müller

2016-06-07	docs/usocket: There must be empty line after .only:: .	Paul Sokolovsky

2016-05-03	docs: Use getaddrinfo() result in easy way.	Paul Sokolovsky
	Instead of extracting 4th element, extact last. Much easier to remember!
2016-04-27	docs/library: Consistently use admonitions for CPython differences.	Paul Sokolovsky

2016-04-23	docs/usocket: Describe address format once at the beginning.	Paul Sokolovsky
	Different ports may have different formats.
2016-04-23	docs/usocket: socket.IPPROTO_SEC is WiPy-specific.	Paul Sokolovsky

2016-04-23	docs/usocket: Socket-specific exceptions are for WiPy only.	Paul Sokolovsky

2016-04-23	docs/library/usocket: Add link to CPython's socket module.	Paul Sokolovsky

2015-10-21	docs: Add usocket and ussl modules' documentation.	danicampora

2014-10-31	docs: Cleanup and update some docs.	Damien George

2014-10-31	docs: Import documentation from source-code inline comments.	Damien George
	The inline docs (prefixed with /// in .c files) have been converted to RST format and put in the docs subdirectory.