Beem 0.20.10 - Fixing lots of documentation syntax errors and typos

작년

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:
image.png
things looked like this:
image.png
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)

BeforeAfter
image.pngimage.png
image.pngimage.png
image.pngimage.png
image.pngimage.png

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

  1. https://beem.readthedocs.io/en/latest/beem.account.html
  2. https://beem.readthedocs.io/en/latest/beem.amount.html
  3. https://beem.readthedocs.io/en/latest/beem.asciichart.html
  4. https://beem.readthedocs.io/en/latest/beem.asset.html
  5. https://beem.readthedocs.io/en/latest/beem.block.html
  6. https://beem.readthedocs.io/en/latest/beem.blockchain.html
  7. https://beem.readthedocs.io/en/latest/beem.comment.html
  8. https://beem.readthedocs.io/en/latest/beem.discussions.html
  9. https://beem.readthedocs.io/en/latest/beem.exceptions.html
  10. https://beem.readthedocs.io/en/latest/beem.imageuploader.html
  11. https://beem.readthedocs.io/en/latest/beem.instance.html
  12. https://beem.readthedocs.io/en/latest/beem.market.html
  13. https://beem.readthedocs.io/en/latest/beem.memo.html
  14. https://beem.readthedocs.io/en/latest/beem.message.html
  15. https://beem.readthedocs.io/en/latest/beem.nodelist.html
  16. https://beem.readthedocs.io/en/latest/beem.notify.html
  17. https://beem.readthedocs.io/en/latest/beem.price.html
  18. https://beem.readthedocs.io/en/latest/beem.snapshot.html
  19. https://beem.readthedocs.io/en/latest/beem.steem.html
  20. https://beem.readthedocs.io/en/latest/beem.steemconnect.html
  21. https://beem.readthedocs.io/en/latest/beem.storage.html
  22. https://beem.readthedocs.io/en/latest/beem.transactionbuilder.html
  23. https://beem.readthedocs.io/en/latest/beem.vote.html
  24. https://beem.readthedocs.io/en/latest/beem.wallet.html
  25. https://beem.readthedocs.io/en/latest/beem.witness.html
  26. https://beem.readthedocs.io/en/latest/beembase.signedtransactions.html
  27. https://beem.readthedocs.io/en/latest/beemgraphenebase.account.html
  28. https://beem.readthedocs.io/en/latest/beemgraphenebase.base58.html
  29. https://beem.readthedocs.io/en/latest/beemgraphenebase.signedtransactions.html
  30. https://beem.readthedocs.io/en/latest/cli.html
  31. https://beem.readthedocs.io/en/latest/configuration.html
  32. https://beem.readthedocs.io/en/latest/contribute.html
  33. https://beem.readthedocs.io/en/latest/modules.html
  34. https://beem.readthedocs.io/en/latest/quickstart.html

GitHub Proof of Authorship

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!
STEEMKR.COM IS SPONSORED BY
ADVERTISEMENT
Sort Order:  trending

Hello @flugschwein,

Welcome to the documentation category as this is your first contribution since I have become CM.

As this contribution was related to typos but minor fixes it is not scored high.

But I highly appreciate the efforts you have put into it to make the Beem docs better.

I really love the passion you have for the project.

Keep contributing.

I am already looking forward to the next documentation contribution from you.

Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.

To view those questions and the relevant answers related to your post, click here.


Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]

·

Thanks for your review!
Let's see if I can spend some more time on the beem documentation :-)

·

Thank you for your review, @ms10398! Keep up the good work!

  ·  작년

Nicely formatted post :) Easy to read.

·

Thanks a lot. I actually feared the opposite xD

If I could turn back !BEER

Hi @flugschwein!

Your post was upvoted by @steem-ua, new Steem dApp, using UserAuthority for algorithmic post curation!
Your post is eligible for our upvote, thanks to our collaboration with @utopian-io!
Feel free to join our @steem-ua Discord server

Hey, @flugschwein!

Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!

Get higher incentives and support Utopian.io!
Simply set @utopian.pay as a 5% (or higher) payout beneficiary on your contribution post (via SteemPlus or Steeditor).

Want to chat? Join us on Discord https://discord.gg/h52nFrV.

Vote for Utopian Witness!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You received more than 4000 upvotes. Your next target is to reach 5000 upvotes.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

The new Steemfest³ Award is ready!
Be ready for the next contest!

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations! This post has been upvoted from the communal account, @minnowsupport, by Flugschwein from the Minnow Support Project. It's a witness project run by aggroed, ausbitbank, teamsteem, someguy123, neoxian, followbtcnews, and netuoso. The goal is to help Steemit grow by supporting Minnows. Please find us at the Peace, Abundance, and Liberty Network (PALnet) Discord Channel. It's a completely public and open space to all members of the Steemit community who voluntarily choose to be there.

If you would like to delegate to the Minnow Support Project you can do so by clicking on the following links: 50SP, 100SP, 250SP, 500SP, 1000SP, 5000SP.
Be sure to leave at least 50SP undelegated on your account.

Just admirable!!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You made more than 4000 upvotes. Your next target is to reach 5000 upvotes.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

SteemFest3 and SteemitBoard - Meet the Steemians Contest

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You received more than 500 as payout for your posts. Your next target is to reach a total payout of 1000

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

The Meet the Steemians Contest is over - Results are coming soon ...

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You got more than 800 replies. Your next target is to reach 900 replies.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

The Meet the Steemians Contest is over - Results are coming soon ...

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You made more than 800 comments. Your next target is to reach 900 comments.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @flugschwein! You received a personal award!

1 Year on Steemit

Click here to view your Board

Do not miss the last post from @steemitboard:

SteemWhales has officially moved to SteemitBoard Ranking
SteemitBoard - Witness Update

Support SteemitBoard's project! Vote for its witness and get one more award!

Congratulations @flugschwein! You have completed the following achievement on the Steem blockchain and have been rewarded with new badge(s) :

You made more than 700 comments. Your next target is to reach 800 comments.

Click here to view your Board of Honor
If you no longer want to receive notifications, reply to this comment with the word STOP

Do not miss the last post from @steemitboard:

SteemFest³ - SteemitBoard Contest Teaser
The new Steemfest³ Award is ready!

Support SteemitBoard's project! Vote for its witness and get one more award!