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

consider adding docstrings #59

Open
yashaka opened this issue Jan 15, 2017 · 5 comments
Open

consider adding docstrings #59

yashaka opened this issue Jan 15, 2017 · 5 comments

Comments

@yashaka
Copy link
Owner

yashaka commented Jan 15, 2017

I am still unsure whether we need them everywhere. Some methods are already obvious in usage...

@yashaka yashaka added the future label Jan 15, 2017
@aleksandr-kotlyar
Copy link
Collaborator

for example

browser.quit
browser.close

@yashaka
Copy link
Owner Author

yashaka commented Jul 14, 2019

Yeah, for some commands it's good to have docstrings:)
like for the ones you mentioned.

@MatuMikey
Copy link

It's pretty good practice to have docstrings for methods - helps a lot with IntelliSense in most IDE's. It's always nice to have, it looks good too. Some of the most popular libraries out there have comments for the most obvious methods. Let us not assume everyone is intelligent enough to figure it out :).

If you would like help with docstrings for methods for documenting everything, I will be more than glad to help @yashaka !

@yashaka
Copy link
Owner Author

yashaka commented Oct 16, 2022

@MatuMikey

I am not sure "most popular libraries" should be used as authority to follow:) I believe we should filter "popularity" by common sense :)

Probably the majority of Selene methods would benefit from having docstrings... If the minority of methods don't need docstrings, then because of "minority" – we still can add docstrings for consistency... But if "half of selene methods" (i.e. not minority) have the context of "nothing useful can be added as docstring", then I would not bloat code with something useless just for consistency. Nevertheless, we have to start adding usefull docstrings first, to see - how much "obvious methods" will remain. Then we can decide what to do with them:) Maybe it will happen that something useful can be added to docstrings of all selene methods:)

Right now I working on #406, that is pretty big chunk of work... Probably we should start working on docstrings after #406 is done...

@yashaka
Copy link
Owner Author

yashaka commented Oct 24, 2022

connected to #456

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants