Fix/docs review - comprehensive documentation review - fix typos and improve consistency#1071
Open
vinipx wants to merge 6 commits intoreportportal:developfrom
Open
Fix/docs review - comprehensive documentation review - fix typos and improve consistency#1071vinipx wants to merge 6 commits intoreportportal:developfrom
vinipx wants to merge 6 commits intoreportportal:developfrom
Conversation
Corrected various literal errors including: - 'maximimum' to 'maximum' in MLSuggestions - 'drug-and-drop' to 'drag-and-drop' in import plugins - 'authorisation' to 'authorization' in ServerSettings - 'lunches' to 'launches' in duration charts - and other minor typo fixes.
Refined language across multiple files for better clarity: - Unified 'Login into'/'Login' to 'Log in to' - Fixed subject-verb agreement (e.g., 'Tags were replaced', 'tickets contain') - Improved phrasing for admin roles (e.g., 'Revoke' instead of 'Take away') - Corrected auxiliary verbs and participle usage (e.g., 'are immediately displayed', 'results depending on')
vinipx
requested review from
AmsterGet,
maria-hambardzumian and
pressayuliya
as code owners
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThis PR applies widespread documentation edits across many files: grammar and typo fixes, phrasing standardization (e.g., "Login into" → "Log in to", "drug-and-drop" → "drag-and-drop"), minor content clarifications, and a few brief procedural step additions. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx (1)
53-53:⚠️ Potential issue | 🟡 MinorMissed typo: "Genetate" → "Generate"
Line 53 contains a pre-existing misspelling ("Genetate Index") that this comprehensive typo-fix PR did not address.
✏️ Suggested fix
-Regenerate index in the OpenSearch. Project settings -> Auto-Analysis -> Genetate Index +Regenerate index in the OpenSearch. Project settings -> Auto-Analysis -> Generate Index🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx` at line 53, Replace the misspelled phrase "Genetate Index" with "Generate Index" in the documentation string "Regenerate index in the OpenSearch. Project settings -> Auto-Analysis -> Genetate Index" so the UI path reads "Project settings -> Auto-Analysis -> Generate Index"; search for the exact token "Genetate Index" to locate and update it.docs/developers-guides/APIDifferencesBetweenV4AndV5.md (2)
78-78:⚠️ Potential issue | 🟡 MinorPre-existing typo: "filer" → "filter".
🐛 Proposed fix
-GET `/v1/project/list` - Retrieve info about all projects by filer. +GET `/v1/project/list` - Retrieve info about all projects by filter.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/APIDifferencesBetweenV4AndV5.md` at line 78, Typo in the docs: change "filer" to "filter" in the GET `/v1/project/list` line; locate the string "GET `/v1/project/list` - Retrieve info about all projects by filer." and update it to "Retrieve info about all projects by filter" (or "by filter criteria") so the endpoint description is correct.
18-18:⚠️ Potential issue | 🟡 MinorPre-existing typo: stray extra
}in endpoint URL.
{widgetId}}has one extra closing brace — surfaced here since this PR is a comprehensive documentation review.🐛 Proposed fix
-PUT `/v1/{projectName}/dashboard/{dashboardId}/{widgetId}}` - Add specified widget to dashboard. +PUT `/v1/{projectName}/dashboard/{dashboardId}/{widgetId}` - Add specified widget to dashboard.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/APIDifferencesBetweenV4AndV5.md` at line 18, The endpoint string `PUT /v1/{projectName}/dashboard/{dashboardId}/{widgetId}}` contains a stray extra closing brace; update the documented route to `PUT /v1/{projectName}/dashboard/{dashboardId}/{widgetId}` by removing the extra `}` wherever the incorrect form appears (search for the exact token `{widgetId}}`) so the path parameter `widgetId` is correctly formatted.
🧹 Nitpick comments (3)
docs/developers-guides/APIDifferencesBetweenV4AndV5.md (1)
26-30: Inconsistent formatting between the two identical note blocks.The
<br />appended to line 107 makes the Test item controller note block internally consistent, but the Launch controller note block (lines 26–30) carries the same prose without any<br />tags. As a comprehensive docs review, consider bringing both blocks to the same formatting style.♻️ Suggested fix — add `
` to the Launch controller note for parity:::note -Tags from v4 were replaced by attributes in v5. -Attribute contains key and value. It may have null key, but non-null value. +Tags from v4 were replaced by attributes in v5.<br /> +Attribute contains key and value. It may have null key, but non-null value.<br /> Attribute with null value is analog for v4 tag. :::Also applies to: 106-110
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/APIDifferencesBetweenV4AndV5.md` around lines 26 - 30, The two identical note blocks describing attributes ("Tags from v4 were replaced by attributes in v5...") must have consistent internal formatting; add a trailing <br /> to the Launch controller note block (the block at the top of the file using the "Attribute contains key and value..." text) so it matches the Test item controller note block formatting, and do the same for the duplicate block around lines 106-110 to ensure parity across both instances.docs/FAQ/index.md (1)
167-167: Optional: prefer the Unicode multiplication sign for dimension notation."300×500 px" (using
×, U+00D7) is the typographically correct symbol for dimensions, distinguishable from the letter "x". The ASCII substitution works, but the original was more precise.✏️ Suggested revert to typed dimension symbol
- - Maximum dimensions: **300x500 px** + - Maximum dimensions: **300×500 px**🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/FAQ/index.md` at line 167, Replace the ASCII "x" with the Unicode multiplication sign U+00D7 in the dimensions text; specifically update the string "Maximum dimensions: **300x500 px**" to use "300×500 px" so the line reads "Maximum dimensions: **300×500 px**" (keep the surrounding formatting and spacing intact).docs/quality-gates/QualityRulesConfiguration.mdx (1)
154-154: Additional typos in this file not addressed by this PR.Since the PR targets typo fixes, consider cleaning up these remaining misspellings in the same file:
Line Current Suggested 154 a attribute(×2),attribut(×2)an attribute,attribute171 a attribute(×2),attribut(×2)an attribute,attribute186 **Ammount of issues in the launch**Amount213 **Ammount of issues in tests with attribute**AmountAlso applies to: 171-171, 186-186, 213-213
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/quality-gates/QualityRulesConfiguration.mdx` at line 154, Fix the remaining typos in QualityRulesConfiguration.mdx: replace the phrase "Failure rate for tests with a attribute" (both occurrences) with "Failure rate for tests with an attribute", correct "attribut" (both occurrences) to "attribute", and change the headings "**Ammount of issues in the launch**" and "**Ammount of issues in tests with attribute**" to "**Amount of issues in the launch**" and "**Amount of issues in tests with attribute**" respectively so all occurrences in the file match the suggested spellings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/admin-panel/AllProjectsPage.mdx`:
- Line 66: Standardize the login phrasing in AllProjectsPage.mdx by replacing
the inconsistent instances of "Log in to ReportPortal instance as
`Administrator`." with the canonical string "Log in to the ReportPortal instance
as an `Administrator`." so all occurrences (the ones currently matching either
form) use the exact wording "Log in to the ReportPortal instance as an
`Administrator`."; search for both variants and update each to the canonical
form.
In `@docs/admin-panel/AllUsersPage.mdx`:
- Line 174: Replace the inconsistent login phrasing on the AllUsersPage.mdx
entry that currently reads "Log in to the ReportPortal instance as
`Administrator`." with the project-standard phrasing "Log in to ReportPortal
instance as `Administrator`."; locate the string in the AllUsersPage.mdx content
(the sentence at the outlier position) and update it so all login instructions
match the other occurrences (Lines near the other login strings).
- Around line 90-92: Update the sentence under the "Assign user to project"
section: change the phrase "To assign user to the project" to "To assign a user
to the project" so it includes the missing article; locate the text with the
heading "Assign user to project" and edit that line accordingly to match the
other docs (e.g., ServerSettings.mdx pattern).
In `@docs/admin-panel/ServerSettings.mdx`:
- Line 106: Replace the incorrect phrase "To assign user to the project:" with
the corrected text "To assign a user to the project:" wherever it appears
(search for the exact string "To assign user to the project:") so the indefinite
article "a" is added to the sentence.
In `@docs/configuration/UserManagement.mdx`:
- Line 22: The sentence contains a grammatical error: replace the incorrect
phrase "as with the `PROJECT_MANAGER` project role" with "as a user with the
`PROJECT_MANAGER` project role" so the step reads "Log in to ReportPortal
instance as a user with the `PROJECT_MANAGER` project role" (search for the
string "as with the `PROJECT_MANAGER` project role" to find and update it).
In `@docs/developers-guides/ReportingDevelopersGuide.md`:
- Line 99: Update the documentation row for the field "rerunOf" to correct the
grammar: change the phrase "Uses with 'rerun' attribute" to "Used with 'rerun'
attribute" so the description reads "Rerun mode. Specifies launch to be rerun.
Used with 'rerun' attribute." Locate the "rerunOf" row in
ReportingDevelopersGuide.md and replace the incorrect wording accordingly.
In `@docs/external-integrations/index.md`:
- Line 10: Replace the mixed-Unicode character in the sentence starting "Thу
integration with **testRigor**..." by changing the Cyrillic 'у' (U+0443) to the
Latin 'y' (U+0079) so the phrase reads "The integration with **testRigor**...";
locate the exact string "Thу integration with **testRigor**" in the docs content
and update that character only, leaving the rest of the sentence unchanged.
In
`@docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md`:
- Line 27: The sentence "Check the logs(service itself and database), in case
we've found nothing, move next." is missing a space before the parenthesis and
is inconsistent with line 12's phrasing; update this line to include the space
and match the style used on line 12 — e.g., change to "Check the logs of
migration (service itself and database), and if nothing is found, proceed to the
next step" — ensuring the parenthetical is preceded by a space and the phrasing
mirrors "logs of migration (service itself...)" for consistency.
In `@docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx`:
- Line 75: The sentence "Slowing down analysis or waiting for a long time for
response." is missing the article before "response"; update the phrase (in the
line containing that exact text) to read "Slowing down analysis or waiting for a
long time for a response." so it includes the indefinite article and corrects
the grammar.
In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx`:
- Line 77: Replace the problematic sentence in
AssessmentOfTestResultsUsingQualityGates.mdx: change "Specially" to
"Especially", replace "CI\CD" with "CI/CD", change "force recalculates" to
"forcibly recalculates" (or "force-recalculates"), and replace the ambiguous
ending "defined status" with "determines the status" so the sentence reads
clearly (e.g., "Especially for integration with CI/CD, Quality Gates has
parameter `Timeout`... It means that after 2 hours after launch finish, the
system forcibly recalculates Quality Gate Status and determines the status.").
In `@docs/releases/archived-releases/Version5.3.1.md`:
- Around line 13-15: Replace the misspelled word "Responce" with "Response" in
the release notes entry that reads "Responce time degradation of the History
Table on Steps Level" (the duplicate misspelling matching "Responce" should be
corrected wherever it appears in this file so both entries are consistent).
---
Outside diff comments:
In `@docs/developers-guides/APIDifferencesBetweenV4AndV5.md`:
- Line 78: Typo in the docs: change "filer" to "filter" in the GET
`/v1/project/list` line; locate the string "GET `/v1/project/list` - Retrieve
info about all projects by filer." and update it to "Retrieve info about all
projects by filter" (or "by filter criteria") so the endpoint description is
correct.
- Line 18: The endpoint string `PUT
/v1/{projectName}/dashboard/{dashboardId}/{widgetId}}` contains a stray extra
closing brace; update the documented route to `PUT
/v1/{projectName}/dashboard/{dashboardId}/{widgetId}` by removing the extra `}`
wherever the incorrect form appears (search for the exact token `{widgetId}}`)
so the path parameter `widgetId` is correctly formatted.
In `@docs/issues-troubleshooting/ResolveAnalyzerKnownIssues.mdx`:
- Line 53: Replace the misspelled phrase "Genetate Index" with "Generate Index"
in the documentation string "Regenerate index in the OpenSearch. Project
settings -> Auto-Analysis -> Genetate Index" so the UI path reads "Project
settings -> Auto-Analysis -> Generate Index"; search for the exact token
"Genetate Index" to locate and update it.
---
Nitpick comments:
In `@docs/developers-guides/APIDifferencesBetweenV4AndV5.md`:
- Around line 26-30: The two identical note blocks describing attributes ("Tags
from v4 were replaced by attributes in v5...") must have consistent internal
formatting; add a trailing <br /> to the Launch controller note block (the block
at the top of the file using the "Attribute contains key and value..." text) so
it matches the Test item controller note block formatting, and do the same for
the duplicate block around lines 106-110 to ensure parity across both instances.
In `@docs/FAQ/index.md`:
- Line 167: Replace the ASCII "x" with the Unicode multiplication sign U+00D7 in
the dimensions text; specifically update the string "Maximum dimensions:
**300x500 px**" to use "300×500 px" so the line reads "Maximum dimensions:
**300×500 px**" (keep the surrounding formatting and spacing intact).
In `@docs/quality-gates/QualityRulesConfiguration.mdx`:
- Line 154: Fix the remaining typos in QualityRulesConfiguration.mdx: replace
the phrase "Failure rate for tests with a attribute" (both occurrences) with
"Failure rate for tests with an attribute", correct "attribut" (both
occurrences) to "attribute", and change the headings "**Ammount of issues in the
launch**" and "**Ammount of issues in tests with attribute**" to "**Amount of
issues in the launch**" and "**Amount of issues in tests with attribute**"
respectively so all occurrences in the file match the suggested spellings.
docs/issues-troubleshooting/HowToResolveIssuesWithMigrationToTheNewVersion.md
Outdated
Show resolved
Hide resolved
docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx
Outdated
Show resolved
Hide resolved
Author
|
@AmsterGet @pressayuliya @maria-hambardzumian looks like we've pushed the coderabbitai to get some extra work done ^^ there are some fixes overlapping with existing PRs. pls, let me know how to proceed - I'd like to see all addressed ❤️ |
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx (3)
56-68:⚠️ Potential issue | 🟡 MinorThree pre-existing grammar/spelling issues not addressed by this PR.
Since the PR's stated goal is comprehensive documentation review, the following unchanged lines have issues worth catching:
Line Current text Fix 56 the systems checksthe system checks(extra 's')56 define a status for each ruledefines a status for each rule(subject-verb agreement)68 **Forth,****Fourth,**(misspelling)✏️ Proposed fixes
-**Second,** if Quality Gates is found, the systems checks all rules in Quality Gate one by one and define a status for each rule +**Second,** if Quality Gates is found, the system checks all rules in Quality Gate one by one and defines a status for each rule-**Forth,** if there is an integration with CI/CD, the system sends status to CI/CD tools to a pipeline. +**Fourth,** if there is an integration with CI/CD, the system sends status to CI/CD tools to a pipeline.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx` around lines 56 - 68, Fix three typos in the Quality Gates doc: change the phrase "the systems checks" to "the system checks" and "define a status for each rule" to "defines a status for each rule" in the sentence starting with "**Second,**" and correct "**Forth,**" to "**Fourth,**" where the next step is introduced; update those exact strings in AssessmentOfTestResultsUsingQualityGates.mdx so subject-verb agreement and spelling are corrected.
25-25:⚠️ Potential issue | 🟡 Minor
N\Auses a backslash — same defect class as theCI\CDfix in line 77.The backslash in
"N\A"is a Markdown escape character and will render asNA(with the backslash silently dropped) in some renderers. Should be"N/A".✏️ Proposed fix
-By default, all launches have "N\A" status. +By default, all launches have "N/A" status.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx` at line 25, The string "N\A" uses a backslash escape and should be changed to "N/A" so it renders correctly; locate the text "N\A" in AssessmentOfTestResultsUsingQualityGates.mdx (same class of issue as the `CI\CD` backslash problem referenced) and replace the backslash with a forward slash so the sentence becomes: By default, all launches have "N/A" status.
90-93:⚠️ Potential issue | 🟡 MinorMissing articles and awkward phrasing in the newly added steps.
Two issues in the added content:
- Line 90:
Choose needed option→Choose the needed option(missing determiner).- Line 93:
no needed optionreads awkwardly;specify custom valueis missing the article "a".✏️ Proposed fix
-* Choose needed option in a dropdown ```"Timeout"``` +* Choose the needed option in the ```"Timeout"``` dropdown-If there is no needed option in the dropdown, you can specify custom value via API. +If the desired option is not available in the dropdown, you can specify a custom value via API.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx` around lines 90 - 93, Fix the wording in the added steps: change "Choose needed option in a dropdown \"Timeout\"" to "Choose the needed option in the \"Timeout\" dropdown" and change "If there is no needed option in the dropdown, you can specify custom value via API." to "If there is no needed option in the dropdown, you can specify a custom value via the API." — update the lines referencing the "Timeout" dropdown and the sentence about specifying a custom value accordingly.
🧹 Nitpick comments (1)
docs/admin-panel/AllUsersPage.mdx (1)
46-46: Nit: "the ReportPortal" reads awkwardly as a standalone proper noun.Consider either "ReportPortal" (no article) or "the ReportPortal instance" for consistency with the phrasing used elsewhere in this file.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/admin-panel/AllUsersPage.mdx` at line 46, Update the awkward phrase "the ReportPortal" in the sentence about recreated personal projects to use consistent naming; replace it with "the ReportPortal instance" (or alternately "ReportPortal" if the rest of the doc uses the bare product name) so the sentence reads e.g. "...and they log in to the ReportPortal instance after that - the deleted personal project will be created once more." Ensure the same phrasing is used consistently in AllUsersPage.mdx for similar references.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx`:
- Line 77: The sentence "Quality Gates has parameter `Timeout`" is missing the
indefinite article; update the sentence in
AssessmentOfTestResultsUsingQualityGates.mdx so it reads "Quality Gates has a
parameter `Timeout`" (locate the phrase "Quality Gates has parameter `Timeout`"
and insert "a" before "parameter" to fix the grammar).
In `@docs/releases/archived-releases/Version5.3.1.md`:
- Line 15: The Markdown lint error is caused by the tag [PreProd] being parsed
as an undefined reference label; locate the line containing "[PreProd]" in
Version5.3.1.md (the entry "High response time(up to 3 min) of the Most Failed
TC Widget loading") and make the tag non-link text by either wrapping it in
backticks (`[PreProd]`), escaping the brackets (\[PreProd\]), or replacing with
an explicit plain-text label like "PreProd" or "(PreProd)"; ensure formatting
matches the other entries (e.g., `[Performance] [PreProd]` with consistent
escaping) so the markdownlint MD052 warning is resolved.
---
Outside diff comments:
In `@docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx`:
- Around line 56-68: Fix three typos in the Quality Gates doc: change the phrase
"the systems checks" to "the system checks" and "define a status for each rule"
to "defines a status for each rule" in the sentence starting with "**Second,**"
and correct "**Forth,**" to "**Fourth,**" where the next step is introduced;
update those exact strings in AssessmentOfTestResultsUsingQualityGates.mdx so
subject-verb agreement and spelling are corrected.
- Line 25: The string "N\A" uses a backslash escape and should be changed to
"N/A" so it renders correctly; locate the text "N\A" in
AssessmentOfTestResultsUsingQualityGates.mdx (same class of issue as the `CI\CD`
backslash problem referenced) and replace the backslash with a forward slash so
the sentence becomes: By default, all launches have "N/A" status.
- Around line 90-93: Fix the wording in the added steps: change "Choose needed
option in a dropdown \"Timeout\"" to "Choose the needed option in the
\"Timeout\" dropdown" and change "If there is no needed option in the dropdown,
you can specify custom value via API." to "If there is no needed option in the
dropdown, you can specify a custom value via the API." — update the lines
referencing the "Timeout" dropdown and the sentence about specifying a custom
value accordingly.
---
Duplicate comments:
In `@docs/admin-panel/AllUsersPage.mdx`:
- Line 34: The phrase "Log in to ReportPortal instance" is missing the definite
article; update each occurrence (e.g., the string "Log in to ReportPortal
instance" found in AllUsersPage.mdx and at the other noted occurrences) to "Log
in to the ReportPortal instance" (or alternatively "Log in to ReportPortal" if
you prefer shorter form) and apply this change consistently for the instances
mentioned on Lines 34, 70, 95, 136, 154, and 191.
---
Nitpick comments:
In `@docs/admin-panel/AllUsersPage.mdx`:
- Line 46: Update the awkward phrase "the ReportPortal" in the sentence about
recreated personal projects to use consistent naming; replace it with "the
ReportPortal instance" (or alternately "ReportPortal" if the rest of the doc
uses the bare product name) so the sentence reads e.g. "...and they log in to
the ReportPortal instance after that - the deleted personal project will be
created once more." Ensure the same phrasing is used consistently in
AllUsersPage.mdx for similar references.
docs/quality-gates/AssessmentOfTestResultsUsingQualityGates.mdx
Outdated
Show resolved
Hide resolved
Author
|
@HardNorth all comments addressed! thank you! |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (3)
docs/developers-guides/ReportingDevelopersGuide.md (3)
509-510:⚠️ Potential issue | 🟡 MinorPre-existing typo: "occurrs" → "occurs" (appears twice).
Double-
rtypo on both lines 509 and 510 in the batch-save-logs response model table. Fits the PR's typo-correction objective.✏️ Proposed fix
-| message (*) | No | Exception message if error occurrs | ... +| message (*) | No | Exception message if error occurs | ... -| stackTrace (*) | No | Stack trace of exception if error occurrs | ... +| stackTrace (*) | No | Stack trace of exception if error occurs | ...🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/ReportingDevelopersGuide.md` around lines 509 - 510, The table rows for "message (*)" and "stackTrace (*)" contain the typo "occurrs"; update both occurrences to "occurs" in the batch-save-logs response model table (look for the cell text "Exception message if error occurrs" and "Stack trace of exception if error occurrs") so both lines read "if error occurs".
25-25:⚠️ Potential issue | 🟡 MinorPre-existing typo: "trough" → "through".
Line 25 contains a typo that falls squarely within this PR's stated objective of fixing misspellings.
✏️ Proposed fix
-We can interact with ReportPortal API instance trough HTTP requests. +We can interact with ReportPortal API instance through HTTP requests.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/ReportingDevelopersGuide.md` at line 25, Replace the misspelled word "trough" in the sentence "We can interact with ReportPortal API instance trough HTTP requests." with the correct spelling "through" so the line reads "We can interact with ReportPortal API instance through HTTP requests."; locate the occurrence of the word "trough" in ReportingDevelopersGuide.md and update it accordingly.
71-71:⚠️ Potential issue | 🟡 MinorPre-existing grammatical issues on line 71: missing "to" and "than" vs "that".
Two issues in the same sentence that fall within the PR's grammar-fix scope.
✏️ Proposed fix
-Next step is retrieve API Key that lives longer that UI-token. +Next step is to retrieve an API Key that lives longer than a UI-token.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/developers-guides/ReportingDevelopersGuide.md` at line 71, Fix the grammatical errors in the sentence "Next step is retrieve API Key that lives longer that UI-token." by adding the missing "to", correcting "that" to "than", and normalizing capitalization and punctuation; replace it with something like: "Next step is to retrieve the API key that lives longer than the UI token." Ensure "API key" and "UI token" use consistent casing and include the article "the" before "UI token" if retained.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@docs/developers-guides/ReportingDevelopersGuide.md`:
- Around line 509-510: The table rows for "message (*)" and "stackTrace (*)"
contain the typo "occurrs"; update both occurrences to "occurs" in the
batch-save-logs response model table (look for the cell text "Exception message
if error occurrs" and "Stack trace of exception if error occurrs") so both lines
read "if error occurs".
- Line 25: Replace the misspelled word "trough" in the sentence "We can interact
with ReportPortal API instance trough HTTP requests." with the correct spelling
"through" so the line reads "We can interact with ReportPortal API instance
through HTTP requests."; locate the occurrence of the word "trough" in
ReportingDevelopersGuide.md and update it accordingly.
- Line 71: Fix the grammatical errors in the sentence "Next step is retrieve API
Key that lives longer that UI-token." by adding the missing "to", correcting
"that" to "than", and normalizing capitalization and punctuation; replace it
with something like: "Next step is to retrieve the API key that lives longer
than the UI token." Ensure "API key" and "UI token" use consistent casing and
include the article "the" before "UI token" if retained.
Author
|
@HardNorth is there anything pending that I should fix/address? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As EPAM ReportPortal Ambassador, I would like to contribute with an important review and enhancement of our documentation 🚀
Overall, the modifications are split into two logical areas:
dashboard for several dashboards."
Summary by CodeRabbit