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

[linting] Require docstrings for all (public) methods #3719

Open
szokeasaurusrex opened this issue Oct 31, 2024 · 1 comment
Open

[linting] Require docstrings for all (public) methods #3719

szokeasaurusrex opened this issue Oct 31, 2024 · 1 comment
Labels
Component: Docs updates on getsentry/docs or docstrings

Comments

@szokeasaurusrex
Copy link
Member

All public API functions should be documented. To enforce this requirement, we should add a linter check that requires any newly-added functions to contain a docstring.

We should discuss whether it makes more sense to enforce docstrings for all functions or only public API functions. Having docstrings for private functions could help us remember what our internal functions are used for, but maybe we don't need to enforce this as a strict requirement.

@antonpirker antonpirker added the Component: Docs updates on getsentry/docs or docstrings label Dec 11, 2024
@antonpirker
Copy link
Member

I think we do not need to enforce it, but just add initial doc strings to all important functions, and then in the future engineers see that we have a lot of doc strings, and will add them too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Docs updates on getsentry/docs or docstrings
Projects
None yet
Development

No branches or pull requests

2 participants