Skip to content

Edits based on feedback#271

Merged
konstantin-melnikov-docs merged 2 commits intodevfrom
auditor-filters-in-advanced
Feb 25, 2026
Merged

Edits based on feedback#271
konstantin-melnikov-docs merged 2 commits intodevfrom
auditor-filters-in-advanced

Conversation

@pavelshabanov2025
Copy link
Contributor

Move the 'Contains' operator down in the table.
A meaningless phrase has been removed after the table.

Move the 'Contains' operator down in the table.
A meaningless phrase has been removed after the table.
@github-actions
Copy link
Contributor

Documentation Review: PR #271

Overview

This PR makes two changes to docs/auditor/10.8/admin/search/filteradvanced.md:

  1. Reorders the "Contains" operator in the Search Conditions table
  2. Removes the sentence about the default operator behavior

Review Findings

Changed Lines Review

The changes themselves are properly formatted and comply with the Netwrix Style Guide. The reordering creates a more logical organization of operators (exact matching → prefix/suffix matching → substring matching → group membership).

Affected Section Issues

The following issues were found in the Search Conditions section (lines 39-62):

docs/auditor/10.8/admin/search/filteradvanced.md, line 41:

  • Issue: "at search" is awkward phrasing
  • Suggested change: Replace "at search" with "when searching" or "during a search"
    • Current: "When you apply filters at search, you can specify operators..."
    • Suggested: "When you apply filters during a search, you can specify operators..."

docs/auditor/10.8/admin/search/filteradvanced.md, line 41:

  • Issue: "the certain filter value" uses redundant articles (Style Guide line 83: articles should be used appropriately)
  • Suggested change: Replace "the certain filter value" with "a certain filter value" or "the specified filter value"
    • Current: "...compare with the certain filter value."
    • Suggested: "...compare with a certain filter value." OR "...compare with the specified filter value."

Note on Removed Content

The removed sentence "When you add a new search filter, the Contains operator is used by default." used passive voice, which violates the Style Guide preference for active voice. However, I cannot verify whether removing this information affects the document's completeness without product knowledge. If this behavior is still true in the product, consider whether users need this information.

Summary

The PR changes follow the Netwrix Style Guide, but the affected section contains two clarity issues that should be addressed for better compliance with the style guide's grammar and article usage standards.

The screenshot has been updated to the appropriate one
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Issues in PR changes

None.

Preexisting issues

  • Line 12: "in details" should be "in detail" (singular form is standard usage)
  • Line 17: "Apply Additional Filters" appears as plain text but should be a cross-reference link to the section below
  • Line 18: "Search Conditions" appears as plain text but should be a cross-reference link to the section below
  • Line 28: Action filter example contains a run-on sentence: "You have already identified the intruder and now you want to see if any files were deleted or moved, and emails sent" has inconsistent structure mixing "or" and "and" and poor parallel construction
  • Line 28: Sentence "Since you are interested in specific actions only, set the Action filter to Removed, Moved, and Sent" is 16 words but the previous sentence is 33 words, making the example difficult to read
  • Line 29: Object type example sentence is 53 words long, exceeding the 25-word guideline for sentence length
  • Line 30: "so you keep receiving search results" uses inconsistent verb tense; should be "so you receive search results"
  • Line 32: Uses "e.g." which violates the style guide rule against Latin abbreviations; should use "for example"
  • Line 35: Uses "e.g." which violates the style guide rule against Latin abbreviations; should use "for example"
  • Line 36: Uses "e.g." which violates the style guide rule against Latin abbreviations; should use "for example"
  • Line 51: Uses "e.g." twice which violates the style guide rule against Latin abbreviations; should use "for example" instead
  • Line 51: Example format is inconsistent with other operators; uses "Use this operator if you want..." instead of "If you set the [Filter] to [operator] [value]..." pattern
  • Line 52: Uses "e.g." which violates the style guide rule against Latin abbreviations; should use "for example"
  • Line 52: List "e.g., Domain1\Johnson, Domain2\John" is missing conjunction; should be "Domain1\Johnson and Domain2\John" for clarity
  • Line 56: Uses "e.g." which violates the style guide rule against Latin abbreviations; should use "for example"

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 @claude here, followed by your instructions (e.g. @claude fix all issues or @claude fix only the spelling errors or @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.

@konstantin-melnikov-docs konstantin-melnikov-docs merged commit 33debd4 into dev Feb 25, 2026
7 checks passed
@konstantin-melnikov-docs konstantin-melnikov-docs deleted the auditor-filters-in-advanced branch February 25, 2026 12:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants