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

TimestampDiffer - parameter "diff" missing in rule documentation #632

Open
niklas-kunz opened this issue Jul 16, 2024 · 1 comment
Open

TimestampDiffer - parameter "diff" missing in rule documentation #632

niklas-kunz opened this issue Jul 16, 2024 · 1 comment
Labels
bug Something isn't working good first issue Good for newcomers verified

Comments

@niklas-kunz
Copy link

Expected behavior
The rule documentation of the TimestampDiffer processor should include a description of all parameters.

Current behavior
The parameter diff is not described in the current documentation.

Possible solution
Adapt docstring of the classlogprep.processor.timestamper.rule.TimestamperRule.Config in order to fix the documentation. It would also be helpful to know the syntax expected in the diff field.
@niklas-kunz niklas-kunz added the bug Something isn't working label Jul 16, 2024
@ekneg54
Copy link
Collaborator

ekneg54 commented Jul 16, 2024

thank you for the feedback

@ekneg54 ekneg54 added the good first issue Good for newcomers label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working good first issue Good for newcomers verified
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ppcad @ekneg54 @niklas-kunz