Skip to content

Add required trait to docs when relevant #469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 27, 2025
Merged

Add required trait to docs when relevant #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion ...re/src/main/java/software/amazon/smithy/python/codegen/generators/StructureGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,13 @@
import software.amazon.smithy.model.shapes.MemberShape;
import software.amazon.smithy.model.shapes.Shape;
import software.amazon.smithy.model.shapes.StructureShape;
import software.amazon.smithy.model.traits.ClientOptionalTrait;
import software.amazon.smithy.model.traits.DefaultTrait;
import software.amazon.smithy.model.traits.DocumentationTrait;
import software.amazon.smithy.model.traits.ErrorTrait;
import software.amazon.smithy.model.traits.InputTrait;
import software.amazon.smithy.model.traits.OutputTrait;
import software.amazon.smithy.model.traits.RequiredTrait;
import software.amazon.smithy.model.traits.SensitiveTrait;
import software.amazon.smithy.model.traits.StreamingTrait;
import software.amazon.smithy.python.codegen.CodegenUtils;
Expand Down Expand Up @@ -316,8 +318,14 @@ private boolean hasDocs() {

private void writeMemberDocs(MemberShape member) {
member.getMemberTrait(model, DocumentationTrait.class).ifPresent(trait -> {
String descriptionPrefix = "";
if (member.hasTrait(RequiredTrait.class) && !member.hasTrait(ClientOptionalTrait.class)) {
descriptionPrefix = "**[Required]** - ";
}

String memberName = symbolProvider.toMemberName(member);
String docs = writer.formatDocs(String.format(":param %s: %s", memberName, trait.getValue()));
String docs = writer.formatDocs(String.format(":param %s: %s%s",
memberName, descriptionPrefix, trait.getValue()));
writer.write(docs);
});
}
Expand Down
11 changes: 8 additions & 3 deletions ...src/main/java/software/amazon/smithy/python/codegen/writer/MarkdownToRstDocConverter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

import static org.jsoup.nodes.Document.OutputSettings.Syntax.html;

import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.commonmark.node.BlockQuote;
import org.commonmark.node.FencedCodeBlock;
import org.commonmark.node.Heading;
Expand Down Expand Up @@ -52,8 +54,11 @@ public static MarkdownToRstDocConverter getInstance() {
}

public String convertCommonmarkToRst(String commonmark) {
String html =
HtmlRenderer.builder().escapeHtml(false).build().render(MARKDOWN_PARSER.parse(commonmark));
String html = HtmlRenderer.builder().escapeHtml(false).build().render(MARKDOWN_PARSER.parse(commonmark));
//Replace the outer HTML paragraph tag with a div tag
Pattern pattern = Pattern.compile("^<p>(.*)</p>$", Pattern.DOTALL);
Matcher matcher = pattern.matcher(html);
html = matcher.replaceAll("<div>$1</div>");
Document document = Jsoup.parse(html);
RstNodeVisitor visitor = new RstNodeVisitor();
document.body().traverse(visitor);
Expand All @@ -75,7 +80,7 @@ public void head(Node node, int depth) {
int secondColonIndex = text.indexOf(':', 1);
writer.write(text.substring(0, secondColonIndex + 1));
//TODO right now the code generator gives us a mixture of
// commonmark and HTML (for instance :param xyz: <p> docs
// RST and HTML (for instance :param xyz: <p> docs
// </p>). Since we standardize to html above, that <p> tag
// starts a newline. We account for that with this if/else
// statement, but we should refactor this in the future to
Expand Down