Skip to content

Need to add example code to various function documentation #10

@JustinWoodring

Description

@JustinWoodring

Some time ago I added support for code examples. In general this is exceedingly valuable to developers quickly wishing to understand function behavior, that said collecting code examples is tedious, so I want to encourage everyone to submit code examples for functions! Not only are you helping out the community, but open-source contributions are a great way get involved and to bolster a resume.

If you feel like contributing additional function documentation that's obviously encouraged as well, but code examples are an easy place to start especially for already documented functions.

If you have any questions let me know!

Here is a documented function with a code example,
https://capibara.tools/capi/stdlib/abs

And here is the function's .yaml file including that same example.
https://github.com/Capibara-Tools/capi/blob/main/stdlib/fn-abs.yaml

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions