-
Notifications
You must be signed in to change notification settings - Fork 751
adding docstring to recattrs sinks and parsers #1368
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
Conversation
ae6f5af
to
70a418d
Compare
…ase update type hints to use Optional[...] from typing.
Hi. Thank you for considering improving the docstrings. Loguru would definitely benefit from having more internal functions documented. Please note that the CI is quite strict and will reject PRs that do not comply with the Ruff linter, in particular, n this case, the rules defined by pydocstyle: https://docs.astral.sh/ruff/rules/#pydocstyle-d Also, be aware that Loguru aims to maintain backward compatibility with Python 3.5. I don't plan on changing that anytime soon, as I want to continue supporting it until the 1.0.0 release. For this reason, unfortunately, you cannot use modern features such as type hints or f-strings. |
@Delgan I have fixed all the CI issues could you please mark this PR |
Great, thanks for your work on the documentation and for keeping the strict CI happy. Note that Loguru's public documentation follows the Numpy style. For consistency, I will likely update your docstrings to align with this convention rather than the Google style used in this PR. But this is very fine as it is, the most important thing being the addition of documentation. |
thanks @Delgan. |
Added docstrings to three modules as part of improving documentation coverage for the repository.