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

Add Example For API Reference in Readme #171

Merged
merged 8 commits into from
Jul 7, 2024

Conversation

threeal
Copy link
Owner

@threeal threeal commented Jul 6, 2024

This pull request resolves #170 by adding examples for API references to the README.md file, replacing the 'Example Usages' section. This change also fixes the description of the fail function regarding how lines are concatenated.

@threeal threeal added the docs label Jul 6, 2024
@threeal threeal added this to the Version 0.4.0 milestone Jul 6, 2024
@threeal threeal self-assigned this Jul 6, 2024
@threeal threeal force-pushed the readme-add-api-reference-examples branch from 559cd67 to be2a06b Compare July 6, 2024 16:02
@threeal threeal force-pushed the readme-add-api-reference-examples branch from 01fe8b1 to 10dd92b Compare July 7, 2024 10:34
@threeal threeal marked this pull request as ready for review July 7, 2024 11:12
@threeal threeal merged commit 9ae9f25 into main Jul 7, 2024
2 checks passed
@threeal threeal deleted the readme-add-api-reference-examples branch July 7, 2024 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Harvested
Development

Successfully merging this pull request may close these issues.

Add Example For API Reference in Readme
1 participant