Add documentation for spacefish API - Githubissues

matchai / spacefish

🚀🐟 The fish shell prompt for astronauts

https://spacefish.matchai.dev

MIT License

964 stars 79 forks source link

Add documentation for spacefish API #54

Closed matchai closed 6 years ago

matchai commented 6 years ago

Description

Ported over and updated the API documentation from spaceship: https://github.com/denysdovhan/spaceship-prompt/blob/master/docs/API.md
Updated SUMMARY.md to include links to the API documentation and sections
Updated CONTRIBUTING.md to include the API documentation

Types of changes

[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Documentation (not affecting end-user functionality)

Checklist:

[ ] I have checked that no other PR duplicates mine
[ ] My code follows the code style of this project.
[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[ ] I have updated the tests accordingly.

matchai commented 6 years ago

@Snuggle regarding ;s in if statements, I tried to just stick with the code style used in the doc examples

I'm thinking of making a code style doc in the future 😄