JOJ0 / synadm

Command line admin tool for Synapse (the Matrix reference homeserver)
https://synadm.readthedocs.io
GNU General Public License v3.0
183 stars 25 forks source link

Fix outdated docs and add "URL encoding chapter" #109

Closed JOJ0 closed 1 year ago

JOJ0 commented 1 year ago

This fixes links to code snippets in CONTRIBUTING.md chapter "Implementation Examples" and adds a chapter about the newly introduced way of formatting strings in the query() method of ApiRequest.

JOJ0 commented 1 year ago

As usual, it's longer than I thought it will be. Give me your critics! ;-) Best viewed in its rendered form in the dev branch: https://github.com/JOJ0/synadm/blob/dev/CONTRIBUTING.md#command-design

I tried to follow the wording from the Python docs: https://docs.python.org/3.9/library/string.html#formatstrings

JOJ0 commented 1 year ago

nitpicker noises

Thanks a lot! Nitpicking appreciated :-)

JOJ0 commented 1 year ago

Unfortunately I forgot to finish this one. There might have been some things that still could be improved but due to lack of time I'm deciding now to better merge it than have inaccurate docs any time longer. I read through it and think it should be understandable by our contributors.