fix code examples in hoodie.account API documentation

gr2m commented 7 years ago

This is a starter issue. It’s up for everyone for taking :) New contributors welcome <3

🤔 What you will need to know

Our documentation website’s source code is part of the hoodie repository and lives in the docs/ folder. Each time there is an update to the repository’s master branch, the documentation on docs.hood.ie gets rebuild automagically through https://readthedocs.org ✨

The Documentation is built from *.rst files, which stands for reStructuredText. It’s mostly text and has some special syntax for things like tables or code highlights. Don’t worry if that’s new to you, you’ll get the hang of it 👍

🐞 The Bug

Open the hoodie.account documentation page. Most examples correctly show hoodie.account, but some towards the and only show account. For example, account.profile.get(properties) should be hoodie.account.profile.get(properties).

:clipboard: Step by Step

[x] 🙋 Claim this issue: Comment below (or assign yourself and continue at step 4 :)
Please 🙏 only claim if you want to start working on it within a day.
Once claimed we add you as contributor to this repository.
[x] 👌 Accept our invitation to this repository. Once accepted, assign yourself to this repository
[x] 👓 Please review our Code of Conduct
In a nutshell: be patient and actively kind with us 😊
[x] 🔄 replace the up for grabs label with in progress.
[x] You can make the edits directly in the browser if you like. Click the "Edit on GitHub" button on top right of the hoodie.account documentation page. Make the changes and commit them with docs: correct hoodie.account code examples
[x] 🔀 Start a Pull Request. Mention closes hoodiehq/camp#122 in the description.
[x] 🏁 Done :+1: Replace the in progress label with ready. Ask in comments for a review :)

🤔❓ Questions

Ping us in the Hoodie Chat or on Twitter

lucask42 commented 7 years ago

Hello gr2m, I'd like to claim this issue 🙋

LowProfileDog commented 7 years ago

Welcome @lucask42 👋🏾🐶 We’ve just invited you to this repository. You can accept the invitation at https://github.com/hoodiehq/camp/invitations and then work off the checklist above. Let us know if you have any questions :)

lucask42 commented 7 years ago

Great!

lucask42 commented 7 years ago

Well that was fun! Please review my pull request :) :) :)

gr2m commented 7 years ago

The new version with your fixes is now online at http://docs.hood.ie/en/latest/api/client/hoodie.account.html#hoodie-account-update. Thanks for your help 👍

hoodiehq / camp