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.

Sign up for GitHub

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

Jump to bottom

Add docstring linting #25154

Open
1 task done
baskaryan opened this issue Aug 7, 2024 · 5 comments
Open
1 task done

Add docstring linting #25154

baskaryan opened this issue Aug 7, 2024 · 5 comments
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder good first issue Good for newcomers help wanted Good issue for contributors

Comments

@baskaryan
Copy link
Collaborator

baskaryan commented Aug 7, 2024 •
edited
Loading

Privileged issue

  • I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.

Issue Content

We want to start enforcing that all public interfaces have proper Google-style docstrings. This is both to improve our code readability and the quality of our API reference.

We can do this by turning on the lint rules shown here: #23187

For each package in the repo we should turn this on and fix all the resulting lint errors.

Specific TODOs:

[] Turn on for core and fix existing issues. Can see what that looks like here #25939
[] Turn on for each integration package
[] Turn on for langchain
[] Turn on for text-splitters
[] Turn on for community
[] Turn on for experimental
@baskaryan baskaryan added help wanted Good issue for contributors good first issue Good for newcomers labels Aug 7, 2024
@dosubot dosubot bot added the 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder label Aug 7, 2024
@Pradyumn-30
Copy link

HI, Can I work on this issue?

@baskaryan
Copy link
Collaborator Author

HI, Can I work on this issue?

copying the update here and fixing all the resulting lint errors would be awesome! #25939

@Vishnu-sai-teja
Copy link

Hey I want to take up this issue , can I work on it ?

@giuliaguglielmi123
Copy link

giuliaguglielmi123 commented Oct 31, 2024 •
edited
Loading

I made some changes on libs/core/langchain_core/_api/beta_decorator.py, may I contribute to this issue ?

@dangiankit dangiankit mentioned this issue Nov 15, 2024
Merged
@dangiankit
Copy link
Contributor

@baskaryan From the above list of TODOs, when you review #28127 (current status: quick to review, passes all 52 checks, and ready to merge) for the text-splitters package, you may want to update the above checklist too.

efriis added a commit that referenced this issue Dec 9, 2024
@dangiankit @efriis
text-splitters: add pydocstyle linting (#28127)
90f162e 
As seen in #23188, turned on Google-style docstrings by enabling
`pydocstyle` linting in the `text-splitters` package. Each resulting
linting error was addressed differently: ignored, resolved, suppressed,
and missing docstrings were added.

Fixes one of the checklist items from #25154, similar to #25939 in
`core` package. Ran `make format`, `make lint` and `make test` from the
root of the package `text-splitters` to ensure no issues were found.

---------

Co-authored-by: Erick Friis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder good first issue Good for newcomers help wanted Good issue for contributors
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@dangiankit @baskaryan @Pradyumn-30 @giuliaguglielmi123 @Vishnu-sai-teja