-
Notifications
You must be signed in to change notification settings - Fork 3.9k
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
Reference topic descriptions have formatting issues #223
Comments
Doug-AWS
assigned eladb, RomainMuller and rix0rrr and unassigned RomainMuller, rix0rrr and eladb
Jul 3, 2018
Let me double-check. |
Still an issue on 0.7.3-beta (build eb3f31a) |
Looks okay. |
HBobertz
added a commit
that referenced
this issue
Feb 1, 2024
* add readme generation * update testing and add readme udpates * add test for readme generation * fix stupid bug I created * improve error message * uncomment tests * address feedback * update readme generation * update warnings: * update warnings: --------- Co-authored-by: Hogan Bobertz <[email protected]>
HBobertz
added a commit
that referenced
this issue
Feb 1, 2024
* add readme generation * update testing and add readme udpates * add test for readme generation * fix stupid bug I created * improve error message * uncomment tests * address feedback * update readme generation * update warnings: * update warnings: --------- Co-authored-by: Hogan Bobertz <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
For example, the blurb for VpcNetwork, ~/.cdk/node_modules/aws-cdk-docs/dist/docs/refs/_aws-cdk_ec2.html#vpcnetwork, looks like:
VpcNetwork deploys an AWS VPC, with public and private subnets per Availability Zone. For example: import { VpcNetwork } from ‘@aws-cdk/ec2’ const vpc = new VpcNetwork(this, { cidr: “10.0.0.0/16” }) // Iterate the public subnets for (let subnet of vpc.publicSubnets) { } // Iterate the private subnets for (let subnet of vpc.privateSubnets) { }
Not very readable.
The text was updated successfully, but these errors were encountered: