refactoring TelegramBotScanner.md

Joel-max-s commented 2 years ago

i refactored the TelegramBotScanner.md - doc-file for better readability

Description

I just added a code block, some code-statements and an unordered list for better readability of the file. The contents where not changed

Type of change

Please make your selection.

[ ] 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 not work as expected)
[ ] This change requires a documentation update
[ ] This change requires a new dependency
[x] Code Maintainability / comments
[ ] Code Refactoring / future-proofing

How Has This Been Tested?

I'ts just a documentation change, watched the new md-file in the preview

Checklist:

[ ] My code follows the style guidelines of this project
[ ] I have performed a self-review of my own code
[ ] I have commented my code, particularly in hard-to-understand areas
[ ] I have made corresponding changes to the documentation
[ ] My changes generate no new warnings
[ ] I have added pytest unit tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes
[ ] Any dependent changes have been merged and published in downstream modules
[ ] I have checked my code and corrected any misspellings

non of them does match, it`s just a little doc-update

whittlem commented 2 years ago

Should this be merged or still in progress?

Joel-max-s commented 2 years ago

Should this be merged or still in progress?

Oops i accidentaly closed the PR. (and opend it right after it again)

From my side it is ready. I didn't use the ````json thing, because the example is not json-comform with the comment behind the value.

warrmr commented 2 years ago

Should this be merged or still in progress?

Oops i accidentaly closed the PR. (and opend it right after it again)

From my side it is ready. I didn't use the ````json thing, because the example is not json-comform with the comment behind the value.

Im down with that :) I think you can use # in JSON for a comment but not all JSON parsers will accept comments in JSON so happy with the reasonings. :)

@whittlem Happy to merge! :)

whittlem / pycryptobot