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

[HELP NEEDED] Add docstring to every function in tirith #90

Open
refeed opened this issue Nov 29, 2022 · 2 comments
Open

[HELP NEEDED] Add docstring to every function in tirith #90

refeed opened this issue Nov 29, 2022 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest

Comments

@refeed
Copy link
Member

refeed commented Nov 29, 2022

Anyone are welcome to contribute to solve this issue!
But there are rules to this:

  1. Please use the reST format when writing the docstring, e.g.
"""
This is a reST style.

:param param1: this is a first param
:param param2: this is a second param
:returns: this is a description of what is returned
:raises keyError: raises an exception
"""
  1. Please only solve one file only per PR. This is to make the probability of people contributing to the same file smaller.
  2. Please mention this issue on your commit and on your PR, e.g. you can add Related to #90 to your commit description and PR.
  3. Please use the format <name of the file>.py: Add docstring for the title of your PR and commit

Is your feature request related to a problem? Please describe.
Most functions in this project don't have docstring yet

E.g

    @staticmethod
    def success(message: str) -> str:
        return TermStyle.str_with_style(message, TermStyle.LIGHT_GREEN + TermStyle.BOLD)

Describe the solution you'd like
I'd like to see the functions in this project to have docstring

e.g.

    @staticmethod
    def success(message: str) -> str:
        """
        Print a success message with green color and bold style.
        """
        return TermStyle.str_with_style(message, TermStyle.LIGHT_GREEN + TermStyle.BOLD)

Describe alternatives you've considered
There are many functions and modules in this project. Hence, this is a very big task, anyone can take this issue. Any PR that does this would be appreciated.

For the next step, we can also put pydocstyle linter in github workflow for a more standardized docstring style https://github.com/PyCQA/pydocstyle


@refeed refeed added the enhancement New feature or request label Nov 29, 2022
@refeed refeed added need-discussion The requirements isn't clear yet, need more thorough discussion and removed need-discussion The requirements isn't clear yet, need more thorough discussion labels Jul 31, 2024
@ritikaaaa177
Copy link
Contributor

Hi @refeed Please assign me this issue.

@refeed
Copy link
Member Author

refeed commented Sep 3, 2024

Everybody can just work on this task without being assigned and send PR directly because this is a very big task :)

@refeed refeed pinned this issue Sep 3, 2024
@refeed refeed unpinned this issue Sep 13, 2024
@refeed refeed pinned this issue Sep 13, 2024
@refeed refeed changed the title 🚀 Add docstring to every function in tirith [HELP NEEDED] Add docstring to every function in tirith Sep 17, 2024
refeed pushed a commit that referenced this issue Oct 1, 2024
refeed pushed a commit that referenced this issue Oct 1, 2024
refeed pushed a commit that referenced this issue Oct 1, 2024
refeed pushed a commit that referenced this issue Oct 1, 2024
refeed pushed a commit that referenced this issue Oct 1, 2024
refeed pushed a commit that referenced this issue Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest
Projects
None yet
Development

No branches or pull requests

2 participants