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

Document Formatters #2994

Open
fselmo opened this issue Jun 15, 2023 · 3 comments
Open

Document Formatters #2994

fselmo opened this issue Jun 15, 2023 · 3 comments

Comments

@fselmo
Copy link
Collaborator

fselmo commented Jun 15, 2023

What was wrong?

We are missing good documentation on our formatters. We should add documentation explaining how formatters work, what each of the default formatters do, and how to customize them if possible.

Since some of the middlewares moved into the formatters, this is especially important for a user's understanding of where and why certain formatting is happening.

@kclowes
Copy link
Collaborator

kclowes commented Jun 15, 2023

I wonder if it makes sense to pull @wolovim's blog post about JSON-RPC round trips into the docs, either via a link or as more of a guide.

@fselmo
Copy link
Collaborator Author

fselmo commented Jun 15, 2023

I think, in general, a section with external links to snakecharmer blog would be great. And having the formatters be documented more thoroughly in the docs in an appropriate section and perhaps linking out to that post for context on usage.

@kclowes
Copy link
Collaborator

kclowes commented Apr 15, 2024

@fselmo do you think this still needs to be done or did it get finished with your new middleware features?

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

No branches or pull requests

2 participants