Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sqlite 3 html documentation shows functions with \* instead of *. #98716

Closed
nadavwe opened this issue Oct 26, 2022 · 7 comments
Closed

Sqlite 3 html documentation shows functions with \* instead of *. #98716

nadavwe opened this issue Oct 26, 2022 · 7 comments
Labels
docs Documentation in the Doc dir topic-sqlite3

Comments

@nadavwe
Copy link

nadavwe commented Oct 26, 2022

Documentation

e.g. see:
https://docs.python.org/3.10/library/sqlite3.html#sqlite3.Connection.backup

other modules look fine.

I tried to look into the code to understand why sqlite outputs different html but the C code looks similar to other modules.

@nadavwe nadavwe added the docs Documentation in the Doc dir label Oct 26, 2022
@nadavwe nadavwe changed the title Sqlite 3 html documentation shows functions with ` Sqlite 3 html documentation shows functions with \* instead of *. Oct 26, 2022
@erlend-aasland erlend-aasland moved this to TODO: Docs in sqlite3 issues Oct 26, 2022
@nadavwe
Copy link
Author

nadavwe commented Oct 26, 2022

hi @erlend-aasland, if you can give me some hint where to look i'd gladly try to solve it myself...

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Oct 26, 2022

hi @erlend-aasland, if you can give me some hint where to look i'd gladly try to solve it myself...

Sure, look in Doc/library/sqlite3.rst. It's just a wrongly applied escape backslash in the docs. There might be more than just that one.

@erlend-aasland
Copy link
Contributor

Here's a list of what needs fixup:

  • blobopen
  • create_function
  • backup
  • serialize
  • deserialize

@erlend-aasland
Copy link
Contributor

erlend-aasland commented Oct 26, 2022

Actually, you can just revert #96081 (yes, these are entirely my fault)

git revert 91afe66707237558d808aeca4683d0822aa0511e

@nadavwe
Copy link
Author

nadavwe commented Oct 26, 2022

if it's a revert then there's no point in me doing it.
I assumed the docs were somehow generated from the C source code...

@erlend-aasland
Copy link
Contributor

Np, thanks for the report though! I can't believe I didn't check the rendered output before merging gh-96081. Lessons learned.

@nadavwe
Copy link
Author

nadavwe commented Oct 26, 2022

Glad to have helped! :)

miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 26, 2022
…ocs (pythonGH-98720)

(cherry picked from commit 365852a)

Co-authored-by: Erlend E. Aasland <[email protected]>
miss-islington added a commit that referenced this issue Oct 26, 2022
(cherry picked from commit 365852a)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit to erlend-aasland/cpython that referenced this issue Oct 26, 2022
…lite3 docs (pythonGH-98720).

(cherry picked from commit 365852a)

Co-authored-by: Erlend E. Aasland <[email protected]>
erlend-aasland added a commit that referenced this issue Oct 26, 2022
Repository owner moved this from TODO: Docs to Done in sqlite3 issues Oct 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir topic-sqlite3
Projects
Status: Done
Development

No branches or pull requests

2 participants