Repository
https://github.com/holgern/beem
Details
Write details of the new/updated official documentation, highlighting all the important changes and additions made.
Looking through the beem documentation, I noticed there were many small things not quite looking like they should. I tried to get the existing documentation to build with no error, and to get it to display like it should. For example, instead of looking like that:
things looked like this:
You'll see that the parameters did not get parsed correctly, and caused the whole paragraph to include some semi-readable text.
Similar errors in the Sphinx Syntax and general typos were fixed by me. There also is a feature by Sphinx that makes linking to other parts of the documentation very comfortable. I applied this to I think all places where this can be applied. This greatly improves the comfort in using the documentation in my opinion (when you can jump right to the documentation of the mentioned classes/functions).
Further examples: (click on the images to view them full screen)
| Before | After |
|---|---|
 |
 |
 |
 |
 |
 |
 |
 |
Nearly all of the changes are similar to those in the above screenshots.
After my changes, the documentation no longer displays any warning when building. I already fixed quite a lot of warnings in this Pull Request some time ago.
Components
The changes I made were spread pretty much all over the documentation. Most of the changes are in parts of the module, that got created or edited after the "birth" of beem.
Links
I changed the following pages of the beem documentation
- https://beem.readthedocs.io/en/latest/beem.account.html
- https://beem.readthedocs.io/en/latest/beem.amount.html
- https://beem.readthedocs.io/en/latest/beem.asciichart.html
- https://beem.readthedocs.io/en/latest/beem.asset.html
- https://beem.readthedocs.io/en/latest/beem.block.html
- https://beem.readthedocs.io/en/latest/beem.blockchain.html
- https://beem.readthedocs.io/en/latest/beem.comment.html
- https://beem.readthedocs.io/en/latest/beem.discussions.html
- https://beem.readthedocs.io/en/latest/beem.exceptions.html
- https://beem.readthedocs.io/en/latest/beem.imageuploader.html
- https://beem.readthedocs.io/en/latest/beem.instance.html
- https://beem.readthedocs.io/en/latest/beem.market.html
- https://beem.readthedocs.io/en/latest/beem.memo.html
- https://beem.readthedocs.io/en/latest/beem.message.html
- https://beem.readthedocs.io/en/latest/beem.nodelist.html
- https://beem.readthedocs.io/en/latest/beem.notify.html
- https://beem.readthedocs.io/en/latest/beem.price.html
- https://beem.readthedocs.io/en/latest/beem.snapshot.html
- https://beem.readthedocs.io/en/latest/beem.steem.html
- https://beem.readthedocs.io/en/latest/beem.steemconnect.html
- https://beem.readthedocs.io/en/latest/beem.storage.html
- https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html
- https://beem.readthedocs.io/en/latest/beem.vote.html
- https://beem.readthedocs.io/en/latest/beem.wallet.html
- https://beem.readthedocs.io/en/latest/beem.witness.html
- https://beem.readthedocs.io/en/latest/beembase.signedtransactions.html
- https://beem.readthedocs.io/en/latest/beemgraphenebase.account.html
- https://beem.readthedocs.io/en/latest/beemgraphenebase.base58.html
- https://beem.readthedocs.io/en/latest/beemgraphenebase.signedtransactions.html
- https://beem.readthedocs.io/en/latest/cli.html
- https://beem.readthedocs.io/en/latest/configuration.html
- https://beem.readthedocs.io/en/latest/contribute.html
- https://beem.readthedocs.io/en/latest/modules.html
- https://beem.readthedocs.io/en/latest/quickstart.html
GitHub Proof of Authorship
- GitHub Account: https://github.com/flugschwein
- Pull Request: https://github.com/holgern/beem/pull/111 As of the posting of this post, the changes I made haven't gone live yet. They are already merged into the master branch though Edit: It's live now :-)
