-
-
Notifications
You must be signed in to change notification settings - Fork 76
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
Enable ruff rules #992
Enable ruff rules #992
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #992 +/- ##
=======================================
Coverage 87.25% 87.25%
=======================================
Files 9 9
Lines 4928 4928
=======================================
Hits 4300 4300
Misses 628 628 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@MarcSkovMadsen why is there a mix of Google and Numpy styles?
def __init__(self,lhs,rhs,operator,reverse=False,**args):
"""Initialize a BinaryOperator with operands, an operator, and optional arguments.
Args:
lhs: The left-hand side operand, which can be a NumberGenerator or a number.
rhs: The right-hand side operand, which can be a NumberGenerator or a number.
operator (Callable): The binary operator to apply to the operands.
reverse (bool, optional): If `True`, swaps the left and right operands. Defaults to `False`.
**args: Optional keyword arguments to pass to the operator when it is called.
Notes
-----
It is currently not possible to set parameters in the superclass during
initialization because `**args` is used by this class itself.
For this PR, and the others you have in preparation, I'm curious and would like to know more about your process. Do you sometimes use an LLM? Or just look at the current docstrings + doc + code ?
Its a mistake. I'm so used to Google docstring style. I will fix it. I dont Think its an issue in other PRs. For this PR I dont remember using a llm a lot as I expected simple to fix issues. For the other PRs I used an llm. I started by explaining I'm updating docstring of HoloViz Param which is using numpy docstring style. I then copy (parts of) the class, function and/ or the user guide to give it context and then ask to Update the docstring. I then copy the proposed docstring back and start reviewing it. I compare to the original. Often i remove repeated text, add a Documentation section or change the examples. I've run all the examples in Ipython. Sometimes I copy the code back to the llm and ask it to improve it further. |
Thanks for fixing the Google Docstring style. As far as I can see the failing macos tests is due to some import change by Philipp. Let me know if there is more I should do here. Thanks. |
It's not, the conda-forge build chain broke pyarrow via libprotobuff and libabseil. Have to wait until they fix it. |
This PR Enables the docstring rules:
This is just a step on the way to improving the content of the docstrings - especially for
.rx
and.param
methods. But first I would like Ruff docstring support to be able to help me.