Giter Club home page Giter Club logo

Comments (3)

yash1th avatar yash1th commented on August 25, 2024

Hi @mcpeak,

This would be my first OSS contribution. Do you want to check the existing docstrings of functions and see whether their descriptions and arguments are correct and clear?

from repokid.

mcpeak avatar mcpeak commented on August 25, 2024

Hi @yash1th , awesome! Thanks for contributing. The point here is to make sure that for all functions we're listing the correct parameters in the docstring. So if a function takes three arguments all the arguments are listed (and described if not obvious) in the docstring. Thanks!

from repokid.

JohnVonNeumann avatar JohnVonNeumann commented on August 25, 2024

So I did a grep -lr "\"\"\"" --exclude-dir=venv-rk/ --exclude-dir=.git to find all files where this would be required:

""" Formatted Docstrings:

  • repokid/init.py

  • repokid/hooks/init.py

  • repokid/cli/repokid_cli.py

  • repokid/utils/dynamo.py

  • repokid/utils/roledata.py

from repokid.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.