Beem documentation update

Image: @creativista

Repository

https://github.com/holgern/beem

Details

Beem is an inofficial python library to access the Steem blockchain, developed and maintained by @holger80. The project already contains a pretty extensive documentation available at http://beem.readthedocs.io/en/latest/, which is auto-generated from the class and function descriptions in the source code. The documentation changes described in this contribution are contained in beem release 0.19.38.

Components

This contribution describes updates to the beem documentation for the comment, memo, account, block, market, blockchain, steemconnect, steem and wallet modules.

Difference

• comment.py:
  • refining authorperm format requirements
  • removing invalid vote weight restrictions
  • adding comment deletion restrictions
  • adding missing parameter descriptions
• memo.py, block.py, steemconnect.py:
  • minor typos corrected
• account.py:
  • clarification on the author reputation format
  • adding missing function descriptions
  • clarifications on return types
  • matching parameter names between function and documentation
  • correcting conversion duration (leftover from an old hardfork)
  • minor typos / wording errors corrected
• market.py, blockchain.py
  • adding missing parameter documentation + minor typos corrected
• steem.py:
  • correcting copy&paste errors and wrong terms that occurred due to replicating function prototypes
  • adding missing parameter documentation
• wallet.py:
  • adding missing parameter documentation

Links

Official documentation generated from the GitHub source files:
http://beem.readthedocs.io/en/latest/

GitHub Proof of Authorship

• GitHub Account: https://github.com/crokkon
• Pull Request: https://github.com/holgern/beem/pull/26