unicorn-binance-trailing-stop-loss icon indicating copy to clipboard operation
unicorn-binance-trailing-stop-loss copied to clipboard

Minor improvements to the docs

Open tijptjik opened this issue 2 years ago • 0 comments

PR Details

Description

  • Fix minor typos in docs
  • Add syntax highlighting to markdown code blocks - this means that when viewed locally, commands can be run (e.g. in PyCharm) as the readme is being read through:

image

  • Edited BinanceTrailingStopLossManager's docstring for clarity - all changes are commited in 22f984af57dc3e9f7b49ea468fd701731d25a54d.
    • Please note @oliver-zehentleitner, the param docs were reordered and grouped for logic, so it is easier for new users to learn about the provided functionality. But I'm unsure about the doc conventions you are using, and my grouping headers / non-alphabetic order may inadvertently mess things up for you, so I'm happy to re-edit if you like the rest of the content changed.
    • Please note that there's also a TODO, as I found one of the params wasn't defined, and still part of the experimental feature you have under development, so I left it blank.

Types of changes

  • [x] Docs change / refactoring / dependency upgrade
  • [ ] 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 change)

Checklist

  • [x] My code follows the code style of this project.
  • [x] My change requires a change to the documentation.
  • [x] I have updated the documentation accordingly.
  • [x] I have read the CONTRIBUTING document.
  • [x] I have added tests to cover my changes.
  • [x] All new and existing tests passed.

tijptjik avatar Apr 17 '23 18:04 tijptjik