pg.ddx.io psycopg/psycopg GitHub issues and pull requestshelp / color / mirror / Atom feed
[psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs 6+ messages / 2 participants [nested] [flat]
* [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2025-08-19 11:50 "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 0 siblings, 0 replies; 6+ messages in thread From: dvarrazzo (@dvarrazzo) @ 2025-08-19 11:50 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> Many objects under `psycopg.types` are not documented [here](https://www.psycopg.org/psycopg3/docs/api/types.html) but scattered elsewhere, such as [in the description of the types mapping](https://www.psycopg.org/psycopg3/docs/basic/pgtypes.html#range-adaptation). This makes the API documentation less complete. There are also items that are not documented at all, such as the `Int8` and similar types wrappers (which can be used to mitigate #1135). ^ permalink raw [nested|flat] 6+ messages in thread
* Re: [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2026-11-07 14:30 ` "Abhishek-Rath (@Abhishek-Rath)" <noreply+Abhishek-Rath@github.com> 4 siblings, 0 replies; 6+ messages in thread From: Abhishek-Rath (@Abhishek-Rath) @ 2026-11-07 14:30 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> Hi @dvarrazzo, I’d like to work on this. My plan: 1. Move the autoclass/autofunction entries for psycopg.types.* from the conceptual pages (mainly basic/pgtypes.rst) into api/types.rst, grouped by module. 2. Replace them in the conceptual pages with cross-references, so the explanations still read naturally. 3. Add API docs for the numeric wrappers (Int2, Int4, Int8, Float4, Float8, Oid, …). Does that structure work for you, or would you prefer a different layout (e.g. one page per module)? ^ permalink raw [nested|flat] 6+ messages in thread
* Re: [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2026-11-07 17:59 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 4 siblings, 0 replies; 6+ messages in thread From: dvarrazzo (@dvarrazzo) @ 2026-11-07 17:59 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> Hello, thank you for looking into this. I think that one single page per `psycopg.types.*` will be enough as the objects are pretty shallow. If the page becomes huge we can decide what to do. ^ permalink raw [nested|flat] 6+ messages in thread
* Re: [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2026-11-08 17:18 ` "Abhishek-Rath (@Abhishek-Rath)" <noreply+Abhishek-Rath@github.com> 4 siblings, 0 replies; 6+ messages in thread From: Abhishek-Rath (@Abhishek-Rath) @ 2026-11-08 17:18 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> Hi @dvarrazzo, I've opened #1487 for this, following your suggestion of a single `api/types.rst` page with one section per submodule. I've also documented the numeric wrappers (`Int8` etc.). A couple of open questions are in the PR description. Happy to adjust anything. Thanks for the guidance! ^ permalink raw [nested|flat] 6+ messages in thread
* Re: [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2026-11-12 17:10 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 4 siblings, 0 replies; 6+ messages in thread From: dvarrazzo (@dvarrazzo) @ 2026-11-12 17:10 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> Hello @Abhishek-Rath I have seen yes, and I thank you very much for your work. I've been busy with the last release 3.3.9 (which you can see from the changelog was pretty massive). Now that I've done made that release I can address your change in the docs, which can be merged regardless of the release cycle. Thank you again! ^ permalink raw [nested|flat] 6+ messages in thread
* Re: [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs @ 2026-11-17 13:50 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 4 siblings, 0 replies; 6+ messages in thread From: dvarrazzo (@dvarrazzo) @ 2026-11-17 13:50 UTC (permalink / raw) To: psycopg/psycopg <noreply+psycopg-psycopg@github.com> @dvarrazzo closed this. ^ permalink raw [nested|flat] 6+ messages in thread
end of thread, other threads:[~2026-11-17 13:50 UTC | newest] Thread overview: 6+ messages (download: mbox mbox.gz follow: Atom feed) -- links below jump to the message on this page -- 2025-08-19 11:50 [psycopg/psycopg] issue #1135: Docs: separate types api documentation from conceptual docs "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 2026-11-07 14:30 ` "Abhishek-Rath (@Abhishek-Rath)" <noreply+Abhishek-Rath@github.com> 2026-11-07 17:59 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 2026-11-08 17:18 ` "Abhishek-Rath (@Abhishek-Rath)" <noreply+Abhishek-Rath@github.com> 2026-11-12 17:10 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com> 2026-11-17 13:50 ` "dvarrazzo (@dvarrazzo)" <noreply+dvarrazzo@github.com>
This inbox is served by DDX for PostgreSQL; see mirroring instructions for how to clone and mirror all data and code used for this inbox