-
Notifications
You must be signed in to change notification settings - Fork 27
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.
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
Fix minor formatting issues in API reference #679
Comments
This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label. |
I am also seeing formatting issues:
|
@vgkowski Thanks for providing the example! I reckon it should be possible to fix those issues as well. |
The issues I mentioned are not related to construct-hub but to jsii-docgen. The generated API.md from jsii-docgen has all the issues mentioned |
The tables in the API reference appear slightly too close to the content above them in some contexts, and asterisks should if possible always be on the same line as last word in the table entry.
Code formatted text
make it look like the paragraph/sentence is indented (more so than it does on other websites).I also wonder if the code formatted text should have a different background color when the entries are in a table?
Screenshot taken from https://constructs.dev/packages/@cloudcamp/aws-runtime/v/0.0.1/
The text was updated successfully, but these errors were encountered: