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

Add docstrings to the SeleniumBase Driver() and SB() definitions #3146

Closed
J-sephB-lt-n opened this issue Sep 19, 2024 · 2 comments · Fixed by #3159
Closed

Add docstrings to the SeleniumBase Driver() and SB() definitions #3146

J-sephB-lt-n opened this issue Sep 19, 2024 · 2 comments · Fixed by #3159
Assignees
Labels
documentation enhancement Making things better

Comments

@J-sephB-lt-n
Copy link

The argument documentation of the Driver function is just a bunch of comments in the function definition.
Can I move these comments to a docstring so that running ..

from seleniumbase import Driver
help(Driver) 

.. prints useful documentation to the user?

Code: https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/driver_manager.py

@mdmintz mdmintz self-assigned this Sep 21, 2024
@mdmintz mdmintz added enhancement Making things better documentation labels Sep 21, 2024
@mdmintz
Copy link
Member

mdmintz commented Sep 21, 2024

I'll update that in the next release.

@mdmintz mdmintz changed the title improve docs: I want to add a function docstring to seleniumbase.Driver Add docstrings to the SeleniumBase Driver() and SB() definitions Sep 21, 2024
@mdmintz
Copy link
Member

mdmintz commented Sep 23, 2024

This was resolved in 4.31.0 - https://github.com/seleniumbase/SeleniumBase/releases/tag/v4.31.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation enhancement Making things better
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants