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

Reference topic descriptions have formatting issues #223

Closed
Doug-AWS opened this issue Jul 2, 2018 · 3 comments
Closed

Reference topic descriptions have formatting issues #223

Doug-AWS opened this issue Jul 2, 2018 · 3 comments

Comments

@Doug-AWS
Copy link
Contributor

Doug-AWS commented Jul 2, 2018

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.

@Doug-AWS
Copy link
Contributor Author

Let me double-check.

@Doug-AWS Doug-AWS added the P3 label Jul 24, 2018
@Doug-AWS
Copy link
Contributor Author

Still an issue on 0.7.3-beta (build eb3f31a)

@Doug-AWS
Copy link
Contributor Author

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
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants