Update 'When' field description with datetime formats#315
Update 'When' field description with datetime formats#315konstantin-melnikov-docs merged 6 commits intodevfrom
Conversation
Clarified the datetime formats supported for the 'When' field in the Activity Record reference.
There was a problem hiding this comment.
Issues in PR changes
- Line 21: Datetime format notation uses inconsistent capitalization. Uses "mm" for month (should be "MM"), "MM" for minute (should be "mm"), and "SS" for second (should be "ss"). Standard datetime format notation: YYYY-MM-ddTHH:mm:ssZ (uppercase MM for month, lowercase mm for minute, lowercase ss for second). Apply to all three formats.
Preexisting issues
- Line 11: Missing article "a" before "maximum". Should read "and a maximum of 1,000 Activity Records".
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Issues in PR changes
- Line 21: Unclear sentence structure. "When supports the following datetime formats:" uses the field name as a sentence subject. Revise to "This field supports the following datetime formats:" for clarity.
Preexisting issues
- Line 11: Missing spacing and article. "50MB and maximum 1,000 Activity Records" should be "50 MB and a maximum of 1,000 Activity Records" (add space before unit, add article before "maximum").
- Line 29: Vague phrase. "References details." should be "References the detail elements listed below." for clarity.
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Issues in PR changes
- Line 21 (When field): HTML tags (
<ul><li>) used in markdown table cell. Markdown tables should use markdown formatting, not raw HTML. This creates rendering inconsistencies and reduces maintainability. - Line 21 (When field): Table cell contains excessively long content with embedded list. This reduces table readability and should be restructured.
- Line 21 (When field): Em dashes used inconsistently in format descriptions. Should use colon or consistent punctuation for technical format specifications.
Preexisting issues
- Line 11: Missing space between number and unit in "50MB" (should be "50 MB" per standard technical writing conventions).
- Line 11: Missing article before "maximum" - should be "a maximum of 1,000 Activity Records".
- Line 18 (Who field): Unusual backslash escape sequence in example "Enterprise\ Administrator" - should be plain text "Enterprise Administrator" or explained if intentional.
- Line 22 (Where field): Incorrect capitalization "NETBIOS" - should be "NetBIOS" (proper trademark capitalization).
- Line 26 (Item field): HTML list tags (
<ul><li>) used in markdown table cell - same issue as line 21. - Line 28 (IsArchiveOnly field): Awkward phrasing "allows saving Activity Record" - should be "allows you to save an Activity Record" or "enables saving an Activity Record".
- Line 29 (DetailList field): Unclear sentence fragment "References details." at end of description - needs clarification or removal.
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Issues in PR changes
- Line 21: Format notation uses lowercase "dd" for day, should be uppercase "DD" to match standard ISO 8601 notation (YYYY-MM-DD format pattern).
- Line 21: Parenthetical descriptions are verbose and repetitive. "(UTC time with zero offset)" can be shortened to "(UTC)", and "(time zones ahead of UTC with positive offset)" and "(time zones behind UTC with negative offset)" can be shortened to "(positive UTC offset)" and "(negative UTC offset)".
Preexisting issues
- Line 11: "50MB" should be "50 MB" (requires space between number and unit).
- Line 11: "and maximum 1,000" should be "and a maximum of 1,000" (missing article).
- Line 18: "Enterprise\ Administrator" contains unnecessary backslash before space. Should be "Enterprise Administrator".
- Line 23: Examples "user, mailbox" should be italicized as "user, mailbox" for consistency with other examples in the document (lines 18, 20, 22, 25).
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Issues in PR changes
- Line 21 (
Whenfield description): Datetime format strings should be in code format for clarity. ChangeYYYY-MM-DDTHH:mm:ssZ (UTC), YYYY-MM-DDTHH:mm:ss+HH:mm (positive UTC offset), and YYYY-MM-DDTHH:mm:ss-HH:mm (negative UTC offset)to use inline code formatting:`YYYY-MM-DDTHH:mm:ssZ` (UTC), `YYYY-MM-DDTHH:mm:ss+HH:mm` (positive UTC offset), and `YYYY-MM-DDTHH:mm:ss-HH:mm` (negative UTC offset).
Preexisting issues
- Line 11: Missing article before "maximum". Change "maximum 1,000 Activity Records" to "a maximum of 1,000 Activity Records".
- Line 11: Missing space between number and unit. Change "50MB" to "50 MB".
- Line 18 (
Whofield description): Unnecessary backslash escape character in example. Change "Enterprise\ Administrator" to "Enterprise Administrator". - Line 26 (
Itemfield description): The last list item contains explanatory text that belongs outside the list. Move the sentences "If you provide an item name for input Activity Records, ensure this item is included in the monitoring plan within the Netwrix API data source. If you specify an item that does not exist, data will be written to the plan's database anyway but will not be available for search using the Item filter." outside the</ul>closing tag and format as a separate paragraph or note. - Line 28 (
IsArchiveOnlyfield description): Missing article. Change "allows saving Activity Record" to "allows saving an Activity Record".
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Issues in PR changes
None.
Preexisting issues
- Line 11-12: "maximum 1,000 Activity Records" is grammatically incomplete. Should be "a maximum of 1,000 Activity Records".
- Line 18: "Enterprise\ Administrator" contains an erroneous backslash-space sequence. Should be "Enterprise\Administrator" (domain\username format) or "Enterprise Administrator" (plain name).
- Line 26: The final list item "Windows file share" incorrectly contains explanatory text about providing item names. This explanatory text should be moved outside the
</ul>tag as a separate paragraph or note. - Line 28: "allows saving Activity Record to" should be "allows saving Activity Records to" (plural for consistency) or "allows saving an Activity Record to" (with article).
There are two ways to apply fixes:
- View them in the comments and apply them individually or in a batch. This only applies to changes made to the file.
- Reply with
@claudehere, followed by your instructions (e.g.@claude fix all issuesor@claude fix only the spelling errorsor@claude fix all other existing issues). You can use this option to fix preexisting issues.
Note: Automated fixes are only available for branches in this repository, not forks.
Clarified the datetime formats supported for the 'When' field in the Activity Record reference.