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

Correct order of parameters in doc strings #251

Closed
czgdp1807 opened this issue Apr 8, 2020 · 3 comments · Fixed by #275
Closed

Correct order of parameters in doc strings #251

czgdp1807 opened this issue Apr 8, 2020 · 3 comments · Fixed by #275
Labels
documentation Improvements or additions to documentation

Comments

@czgdp1807
Copy link
Member

Description of the problem

As of now, the order of Parameters in docstrings of classes/functions doesn't align with the order required in their prototype. For example, TreeNode(key, data=None) then the order of parameters in doc strings should be,

Parameters
=========

key
...

data
...

and NOT,

Parameters
=========

data
...

key
...

All doc strings should be checked for this consistency for closing this issue.

Example of the problem

References/Other comments

@czgdp1807 czgdp1807 added documentation Improvements or additions to documentation medium labels Apr 8, 2020
@Amitsharma45
Copy link

can you explain this issue in detial

@Rukmini-Meda
Copy link

I would like to work on this issue. Please assign this to me as part of GSSoC'20.

@robotjellyzone
Copy link

Hi @Rukmini-Meda yes, you can work on this issue go ahead!

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

Successfully merging a pull request may close this issue.

4 participants