Skip to content
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

Open
Chriscbr opened this issue Dec 15, 2021 · 5 comments
Open

Fix minor formatting issues in API reference #679

Chriscbr opened this issue Dec 15, 2021 · 5 comments
Labels

Comments

@Chriscbr
Copy link
Contributor

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?

Screen Shot 2021-12-14 at 5 48 46 PM

Screenshot taken from https://constructs.dev/packages/@cloudcamp/aws-runtime/v/0.0.1/

@Chriscbr Chriscbr added the p2 label Dec 15, 2021
@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot added the stale label Feb 14, 2022
@Chriscbr Chriscbr removed the stale label Feb 14, 2022
@vgkowski
Copy link

I am also seeing formatting issues:

@Chriscbr
Copy link
Contributor Author

@vgkowski Thanks for providing the example! I reckon it should be possible to fix those issues as well.

@vgkowski
Copy link

vgkowski commented Mar 21, 2022

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

@vgkowski
Copy link

cdklabs/jsii-docgen#642

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants