Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor improvements to the docs #25

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

tijptjik
Copy link

@tijptjik tijptjik commented Apr 17, 2023

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 22f984a.
    • 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

  • 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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant