Skip to content

Commit 386fa97

Browse files
Use placeholder documentation
1 parent 5864974 commit 386fa97

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

smithy-docgen-core/src/main/java/software/amazon/smithy/docgen/core/writers/MarkdownWriter.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
import software.amazon.smithy.model.Model;
1818
import software.amazon.smithy.model.shapes.Shape;
1919
import software.amazon.smithy.model.traits.DocumentationTrait;
20+
import software.amazon.smithy.model.traits.StringTrait;
2021
import software.amazon.smithy.utils.Pair;
2122
import software.amazon.smithy.utils.SmithyUnstableApi;
2223
import software.amazon.smithy.utils.StringUtils;
@@ -37,7 +38,6 @@ public MarkdownWriter(DocImportContainer importContainer, String filename) {
3738
super(importContainer, filename);
3839
}
3940

40-
4141
/**
4242
* Constructs a MarkdownWriter.
4343
*
@@ -104,8 +104,9 @@ public DocWriter writeShapeDocs(Shape shape, Model model) {
104104
} else {
105105
docTrait = shape.getTrait(DocumentationTrait.class);
106106
}
107-
docTrait.map(DocumentationTrait::getValue)
108-
.ifPresent(this::writeWithNewline);
107+
var documentation = docTrait.map(StringTrait::getValue)
108+
.orElse("Placeholder documentation for `" + shape.getId() + "`");
109+
writeWithNewline(documentation.replace("$", "$$"));
109110
return this;
110111
}
111112

0 commit comments

Comments
 (0)