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

Show context for component #11841

Open
RDavis3000 opened this issue May 15, 2024 · 0 comments
Open

Show context for component #11841

RDavis3000 opened this issue May 15, 2024 · 0 comments
Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec

Comments

@RDavis3000
Copy link

File: themes/default/content/docs/concepts/inputs-outputs/apply.md

This page uses

`return await Deployment.RunAsync(() =>
{
var vpc = new Vpc("vpc");

Console.WriteLine(vpc);

});`

as an example, but has no indication of what Vpc is or what it could conceivably output! What is a VPC and how would I know if I saw one on the street?
Also using "vpc" as the name for EVERYTHING in this code (the variable, the class, and the argument) makes it more likely it will be unclear which "vpc" is doing what. (This is just a stylistic recommendation).

@github-actions github-actions bot added the needs-triage Needs attention from the triage team label May 15, 2024
@cnunciato cnunciato transferred this issue from pulumi/pulumi-hugo May 16, 2024
@cnunciato cnunciato added area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec and removed needs-triage Needs attention from the triage team labels May 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation kind/bug Some behavior is incorrect or out of spec
Projects
Status: 🧳 Backlog
Development

No branches or pull requests

2 participants