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

Content Plan Task--Code snippets #540

Closed
JuLeeAtPlanet opened this issue May 11, 2022 · 1 comment · May be fixed by #939
Closed

Content Plan Task--Code snippets #540

JuLeeAtPlanet opened this issue May 11, 2022 · 1 comment · May be fixed by #939

Comments

@JuLeeAtPlanet
Copy link
Contributor

For the sake of this document, a code snippet is a block of code in the documentation that provides a code example of how to use the command being documented. A code snippet is not the output of the source code in the SDK. A code snippet for the SDK is not the CLI string.

Provide a code snippet for each call, using real-life terms (i.e., not foo & bar).

Provide a CLI cheat sheet (separate from the SDK) with examples using real-life terms. (See, for example, The gcloud CLI cheat sheet.)

@tbarsballe
Copy link
Contributor

#540 better captures what we actually want for documentation, closing this as wontfix

@tbarsballe tbarsballe closed this as not planned Won't fix, can't repro, duplicate, stale Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

Successfully merging a pull request may close this issue.

5 participants