diff --git a/CHANGELOG.md b/CHANGELOG.md index 7d96ba655..ac45040c8 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -29,6 +29,7 @@ the list is now fixed inside the packaged logprep * allow `TimeParser` to get the current time with a specified timezone instead of always using local time and setting the timezone to UTC * remove `tldextract` dependency * remove `urlextract` dependency +* fix wrong documentation for `timestamp_differ` ### Bugfix diff --git a/logprep/processor/timestamp_differ/rule.py b/logprep/processor/timestamp_differ/rule.py index 1ac50fd2d..50d522d06 100644 --- a/logprep/processor/timestamp_differ/rule.py +++ b/logprep/processor/timestamp_differ/rule.py @@ -2,9 +2,7 @@ Rule Configuration ^^^^^^^^^^^^^^^^^^ -The timestamp format can be specified per timestamp. Following patterns can be used to define the -timestamp format: -`Timestamp tokens `_. +The timestamp format can be specified per timestamp. A speaking example: @@ -31,7 +29,7 @@ {"ingest": "2022-12-06 10:00:00", "processed": "2022-12-06 10:00:05", "processing_time": "5.0"} -.. autoclass:: logprep.processor.timestamper.rule.TimestamperRule.Config +.. autoclass:: logprep.processor.timestamp_differ.rule.TimestampDifferRule.Config :members: :undoc-members: :inherited-members: @@ -69,8 +67,8 @@ class Config(FieldManagerRule.Config): and the timestamp format can be specified in the form of: :code:`${dotted.field.path:timestamp-format}`. If no timestamp format is given, e.g. :code:`${dotted.field.path}`, the string will be assumed as an iso8601 compliant string and - parsed. For more information on the format syntax see - `datetime strftime/strptime `_.""" + parsed. For more information on the format syntax see `datetime strftime/strptime + `_.""" source_fields: list = field(factory=list) source_field_formats: list = field(factory=list) output_format: str = field(