Skip to content

Add examples/ in the repo #236

@lazysegtree

Description

@lazysegtree

We could add around 5-10 common usage examples in examples/ directory with this format

file - descriptive_name.go

content -

<go code>
/* 
<Detailed explanation of what program does if needed>

<Equivalent shell script>
*/
  • Makes it easy for new users to understand the API
  • Makes it easy for users to implement a solution for them, by providing them a reference of real world use cases
  • It allows providing larger examples that cannot fit in ReadMe
  • It allows providing more examples, as Readme cannot fit too many examples.
  • Its standard practive

Bonus

  • We could add some sort of check in GitHub Actions to ensure all examples runs. That will be a good intergeration test.

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