Skip to content

Content Plan Task--Code snippets #540

@JuLeeAtPlanet

Description

@JuLeeAtPlanet
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.)

Activity

modified the milestones: 2.0b2: Iterative improvements, 2.0b3 on Jan 18, 2023
modified the milestones: 2.0b3, 2.0b4 on Jan 18, 2023
linked a pull request that will close this issueCode snippets for all APIs #939on May 11, 2023
tbarsballe

tbarsballe commented on Aug 8, 2024

@tbarsballe
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Type

No type

Projects

Status

Done

Relationships

None yet

    Development

    Participants

    @cholmes@jreiberkyle@tbarsballe@kevinlacaille@JuLeeAtPlanet

    Issue actions

      Content Plan Task--Code snippets · Issue #540 · planetlabs/planet-client-python