Skip to content

https://mysqlclient.readthedocs.io/ documentation is outdated #552

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

Closed
matusvalo opened this issue Aug 12, 2022 · 4 comments
Closed

https://mysqlclient.readthedocs.io/ documentation is outdated #552

matusvalo opened this issue Aug 12, 2022 · 4 comments

Comments

@matusvalo
Copy link

Read this first

We don't use this issue tracker to help users. If you had trouble, please ask it on some user community. See here.
Please use this tracker only when you are sure about it is an issue of this software.

And please provide full information from first. I don't want to ask questions like "What is your Python version?", "Do you confirm MySQL error log?". If the issue report looks incomplete, I will just close it.

Are you ready? Please remove until here and make a good issue report!!

Describe the bug

Documentation in https://mysqlclient.readthedocs.io/ is outdated comparing to the code in repository. The last build is 2 years old:
image

So some new functionality (e.g. ssl_mode parameter) is present only in source code and easily missed by users.

@matusvalo matusvalo changed the title https://mysqlclient.readthedocs.io/ documenation is outdated https://mysqlclient.readthedocs.io/ documentation is outdated Aug 12, 2022
@okainov
Copy link

okainov commented Jan 16, 2023

It seems very out-of-date, even the connect example is wrong, the actual code will complain for db or passwd parameters...

@methane
Copy link
Member

methane commented Jan 17, 2023

I had changed the default branch name from master to main.
I think it broke the RTD.

@methane
Copy link
Member

methane commented Jan 17, 2023

libmysqlclient is needed to build the doc.
So I can not fix the RTD manual.

@methane
Copy link
Member

methane commented Jan 17, 2023

I succeeded to build the doc by adding config file.

@methane methane closed this as completed Jan 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants