Skip to content

Suggestion: Examples are lacking best practices #3

Description

@albvar

The function help examples for the majority of the examples are really hard to follow.
The function help examples should leverage examples that the consumers can easily plug in and visualize the output without having to understand the dependencies from function to function. A good way I like to think of this is as follows. Put yourself in the shoes of someone who has never seen this before, how can they quickly figure out if this module does what they need.

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions