Skip to content

Reference topic descriptions have formatting issues #223

@Doug-AWS

Description

@Doug-AWS

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions