Skip to content

Commit 470f2a1

Browse files
author
awstools
committed
docs(client-codeguru-reviewer): Documentation updates to fix formatting issues in CLI and SDK documentation.
1 parent da66ee3 commit 470f2a1

15 files changed

+615
-1070
lines changed

‎clients/client-codeguru-reviewer/README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,23 @@
99

1010
AWS SDK for JavaScript CodeGuruReviewer Client for Node.js, Browser and React Native.
1111

12-
<p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service
13-
that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends
14-
fixes in your Java and Python code.</p>
15-
16-
<p>By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer
17-
improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the
12+
<p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a
13+
service that uses program analysis and machine learning to detect potential defects that
14+
are difficult for developers to find and recommends fixes in your Java and Python
15+
code.</p>
16+
17+
<p>By proactively detecting and providing recommendations for addressing code defects and
18+
implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of
19+
your code base during the code review stage. For more information about CodeGuru Reviewer, see the
1820
<i>
1921
<a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html">Amazon CodeGuru Reviewer User Guide</a>.</i>
2022
</p>
2123

22-
<p>
23-
To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by
24-
creating an <i>interface VPC endpoint</i>. For more information, see
25-
<a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface
26-
VPC endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
27-
</p>
24+
<p>To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection
25+
between your VPC and CodeGuru Reviewer by creating an <i>interface VPC endpoint</i>. For
26+
more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface VPC
27+
endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User
28+
Guide</i>.</p>
2829

2930
## Installing
3031

‎clients/client-codeguru-reviewer/src/CodeGuruReviewer.ts

Lines changed: 43 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -70,48 +70,47 @@ import {
7070
} from "./commands/UntagResourceCommand";
7171

7272
/**
73-
* <p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service
74-
* that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends
75-
* fixes in your Java and Python code.</p>
73+
* <p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a
74+
* service that uses program analysis and machine learning to detect potential defects that
75+
* are difficult for developers to find and recommends fixes in your Java and Python
76+
* code.</p>
7677
*
77-
* <p>By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer
78-
* improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the
79-
* <i>
78+
* <p>By proactively detecting and providing recommendations for addressing code defects and
79+
* implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of
80+
* your code base during the code review stage. For more information about CodeGuru Reviewer, see the
81+
* <i>
8082
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html">Amazon CodeGuru Reviewer User Guide</a>.</i>
8183
* </p>
8284
*
83-
* <p>
84-
* To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by
85-
* creating an <i>interface VPC endpoint</i>. For more information, see
86-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface
87-
* VPC endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
88-
* </p>
85+
* <p>To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection
86+
* between your VPC and CodeGuru Reviewer by creating an <i>interface VPC endpoint</i>. For
87+
* more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface VPC
88+
* endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User
89+
* Guide</i>.</p>
8990
*/
9091
export class CodeGuruReviewer extends CodeGuruReviewerClient {
9192
/**
92-
* <p>
93-
* Use to associate an Amazon Web Services CodeCommit repository or a repostory managed by
94-
* Amazon Web Services CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a
95-
* repository, CodeGuru Reviewer reviews source code changes in the repository's pull requests and provides
96-
* automatic recommendations. You can view recommendations using the CodeGuru Reviewer console. For more information, see
97-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html">Recommendations in
93+
* <p>Use to associate an Amazon Web Services CodeCommit repository or a repository managed by Amazon Web Services
94+
* CodeStar Connections with Amazon CodeGuru Reviewer. When you associate a repository, CodeGuru Reviewer reviews
95+
* source code changes in the repository's pull requests and provides automatic
96+
* recommendations. You can view recommendations using the CodeGuru Reviewer console. For more
97+
* information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/recommendations.html">Recommendations in
9898
* Amazon CodeGuru Reviewer</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i>
99-
* </p>
99+
* </p>
100100
*
101-
* <p>If you associate a CodeCommit or S3 repository, it must be in the same
102-
* Amazon Web Services Region and Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.</p>
101+
* <p>If you associate a CodeCommit or S3 repository, it must be in the same Amazon Web Services Region and
102+
* Amazon Web Services account where its CodeGuru Reviewer code reviews are configured.</p>
103103
*
104104
* <p>Bitbucket and GitHub Enterprise Server repositories are managed by Amazon Web Services CodeStar
105-
* Connections to connect to CodeGuru Reviewer. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html">Associate a repository</a> in
106-
* the <i>Amazon CodeGuru Reviewer User Guide.</i>
105+
* Connections to connect to CodeGuru Reviewer. For more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-associate-repository.html">Associate a
106+
* repository</a> in the <i>Amazon CodeGuru Reviewer User Guide.</i>
107107
* </p>
108108
*
109109
* <note>
110-
* <p>
111-
* You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with Amazon CodeGuru Reviewer. To associate
112-
* a GitHub repository, use the console. For more information, see
113-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html">Getting
114-
* started with CodeGuru Reviewer</a> in the <i>CodeGuru Reviewer User Guide.</i>
110+
* <p>You cannot use the CodeGuru Reviewer SDK or the Amazon Web Services CLI to associate a GitHub repository with
111+
* Amazon CodeGuru Reviewer. To associate a GitHub repository, use the console. For more information, see
112+
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/getting-started-with-guru.html">Getting started with
113+
* CodeGuru Reviewer</a> in the <i>CodeGuru Reviewer User Guide.</i>
115114
* </p>
116115
* </note>
117116
*/
@@ -145,13 +144,10 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
145144
}
146145

147146
/**
148-
* <p>
149-
* Use to create a code review with a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">
150-
* <code>CodeReviewType</code>
151-
* </a>
152-
* of <code>RepositoryAnalysis</code>. This type of code review analyzes all code under a specified branch in an associated repository.
153-
* <code>PullRequest</code> code reviews are automatically triggered by a pull request.
154-
* </p>
147+
* <p>Use to create a code review with a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_CodeReviewType.html">CodeReviewType</a> of
148+
* <code>RepositoryAnalysis</code>. This type of code review analyzes all code under a
149+
* specified branch in an associated repository. <code>PullRequest</code> code reviews are
150+
* automatically triggered by a pull request.</p>
155151
*/
156152
public createCodeReview(
157153
args: CreateCodeReviewCommandInput,
@@ -183,7 +179,7 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
183179
}
184180

185181
/**
186-
* <p> Returns the metadata associated with the code review along with its status.</p>
182+
* <p>Returns the metadata associated with the code review along with its status.</p>
187183
*/
188184
public describeCodeReview(
189185
args: DescribeCodeReviewCommandInput,
@@ -215,9 +211,7 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
215211
}
216212

217213
/**
218-
* <p>
219-
* Describes the customer feedback for a CodeGuru Reviewer recommendation.
220-
* </p>
214+
* <p>Describes the customer feedback for a CodeGuru Reviewer recommendation.</p>
221215
*/
222216
public describeRecommendationFeedback(
223217
args: DescribeRecommendationFeedbackCommandInput,
@@ -249,12 +243,8 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
249243
}
250244

251245
/**
252-
* <p>
253-
* Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">
254-
* <code>RepositoryAssociation</code>
255-
* </a> object
256-
* that contains information about the requested repository association.
257-
* </p>
246+
* <p>Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociation.html">RepositoryAssociation</a> object that contains information about the requested
247+
* repository association.</p>
258248
*/
259249
public describeRepositoryAssociation(
260250
args: DescribeRepositoryAssociationCommandInput,
@@ -318,9 +308,7 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
318308
}
319309

320310
/**
321-
* <p>
322-
* Lists all the code reviews that the customer has created in the past 90 days.
323-
* </p>
311+
* <p>Lists all the code reviews that the customer has created in the past 90 days.</p>
324312
*/
325313
public listCodeReviews(
326314
args: ListCodeReviewsCommandInput,
@@ -352,13 +340,8 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
352340
}
353341

354342
/**
355-
* <p>
356-
* Returns a list of
357-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html">
358-
* <code>RecommendationFeedbackSummary</code>
359-
* </a>
360-
* objects that contain customer recommendation feedback for all CodeGuru Reviewer users.
361-
* </p>
343+
* <p>Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RecommendationFeedbackSummary.html">RecommendationFeedbackSummary</a> objects that contain customer recommendation
344+
* feedback for all CodeGuru Reviewer users.</p>
362345
*/
363346
public listRecommendationFeedback(
364347
args: ListRecommendationFeedbackCommandInput,
@@ -390,9 +373,7 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
390373
}
391374

392375
/**
393-
* <p>
394-
* Returns the list of all recommendations for a completed code review.
395-
* </p>
376+
* <p>Returns the list of all recommendations for a completed code review.</p>
396377
*/
397378
public listRecommendations(
398379
args: ListRecommendationsCommandInput,
@@ -424,24 +405,8 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
424405
}
425406

426407
/**
427-
* <p>
428-
* Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html">
429-
* <code>RepositoryAssociationSummary</code>
430-
* </a> objects that
431-
* contain summary information about a repository association. You can filter the returned list by
432-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType">
433-
* <code>ProviderType</code>
434-
* </a>,
435-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name">
436-
* <code>Name</code>
437-
* </a>,
438-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State">
439-
* <code>State</code>
440-
* </a>, and
441-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner">
442-
* <code>Owner</code>
443-
* </a>.
444-
* </p>
408+
* <p>Returns a list of <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html">RepositoryAssociationSummary</a> objects that contain summary information about a
409+
* repository association. You can filter the returned list by <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-ProviderType">ProviderType</a>, <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Name">Name</a>, <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-State">State</a>, and <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-api/API_RepositoryAssociationSummary.html#reviewer-Type-RepositoryAssociationSummary-Owner">Owner</a>.</p>
445410
*/
446411
public listRepositoryAssociations(
447412
args: ListRepositoryAssociationsCommandInput,
@@ -505,9 +470,8 @@ export class CodeGuruReviewer extends CodeGuruReviewerClient {
505470
}
506471

507472
/**
508-
* <p>
509-
* Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with different reactions the previous feedback is overwritten.
510-
* </p>
473+
* <p>Stores customer feedback for a CodeGuru Reviewer recommendation. When this API is called again with
474+
* different reactions the previous feedback is overwritten.</p>
511475
*/
512476
public putRecommendationFeedback(
513477
args: PutRecommendationFeedbackCommandInput,

‎clients/client-codeguru-reviewer/src/CodeGuruReviewerClient.ts

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -282,22 +282,23 @@ type CodeGuruReviewerClientResolvedConfigType = __SmithyResolvedConfiguration<__
282282
export interface CodeGuruReviewerClientResolvedConfig extends CodeGuruReviewerClientResolvedConfigType {}
283283

284284
/**
285-
* <p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a service
286-
* that uses program analysis and machine learning to detect potential defects that are difficult for developers to find and recommends
287-
* fixes in your Java and Python code.</p>
285+
* <p>This section provides documentation for the Amazon CodeGuru Reviewer API operations. CodeGuru Reviewer is a
286+
* service that uses program analysis and machine learning to detect potential defects that
287+
* are difficult for developers to find and recommends fixes in your Java and Python
288+
* code.</p>
288289
*
289-
* <p>By proactively detecting and providing recommendations for addressing code defects and implementing best practices, CodeGuru Reviewer
290-
* improves the overall quality and maintainability of your code base during the code review stage. For more information about CodeGuru Reviewer, see the
291-
* <i>
290+
* <p>By proactively detecting and providing recommendations for addressing code defects and
291+
* implementing best practices, CodeGuru Reviewer improves the overall quality and maintainability of
292+
* your code base during the code review stage. For more information about CodeGuru Reviewer, see the
293+
* <i>
292294
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/welcome.html">Amazon CodeGuru Reviewer User Guide</a>.</i>
293295
* </p>
294296
*
295-
* <p>
296-
* To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection between your VPC and CodeGuru Reviewer by
297-
* creating an <i>interface VPC endpoint</i>. For more information, see
298-
* <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface
299-
* VPC endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User Guide</i>.
300-
* </p>
297+
* <p>To improve the security of your CodeGuru Reviewer API calls, you can establish a private connection
298+
* between your VPC and CodeGuru Reviewer by creating an <i>interface VPC endpoint</i>. For
299+
* more information, see <a href="https://docs.aws.amazon.com/codeguru/latest/reviewer-ug/vpc-interface-endpoints.html">CodeGuru Reviewer and interface VPC
300+
* endpoints (Amazon Web Services PrivateLink)</a> in the <i>Amazon CodeGuru Reviewer User
301+
* Guide</i>.</p>
301302
*/
302303
export class CodeGuruReviewerClient extends __Client<
303304
__HttpHandlerOptions,

0 commit comments

Comments
 (0)