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

Improve docs #11

Open
paxcema opened this issue Oct 18, 2022 · 3 comments
Open

Improve docs #11

paxcema opened this issue Oct 18, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@paxcema
Copy link
Member

paxcema commented Oct 18, 2022

Right now, documentation is in a very preliminar and rough state.

Any help towards making it easier to understand the codebase and the purpose of the package will be of great help.

@paxcema paxcema added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Oct 18, 2022
@Sumanth077
Copy link

Hi @paxcema Happy to help in making the documentation better and your support towards that will be great.

@paxcema
Copy link
Member Author

paxcema commented Jan 25, 2023

Hey @Sumanth077 thanks for your interest!

A good primer for this, in order to leverage our automated documentation builder system, is to generate docstrings for all methods and classes that are missing one.

In particular, our coverage for this is poor in type_infer/infer.py and type_infer/helpers.py. To start, I would propose that you add docstrings to all methods/classes that you're able to easily understand, and we can make adjustments to them once you open a Pull Request with the changes. Once merged, these will be reflected in the docs URL.

To make sense of the code, I would recommend playing around with the library in a Python console, either importing it standalone or through Lightwood.

@Sumanth077
Copy link

Thank you @paxcema. Will work on that and make an initial Draft PR.

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 enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants