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.

Sign up for GitHub

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

Jump to bottom

Consistent use of markdown inline code for responses #121

Open
malandis opened this issue Mar 9, 2023 · 0 comments
Open

Consistent use of markdown inline code for responses #121

malandis opened this issue Mar 9, 2023 · 0 comments
Assignees
@NoSQLKnowHow
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@malandis
Copy link
Contributor

malandis commented Mar 9, 2023 •
edited
Loading

Some dictionary collections responses use inline code markdown for the response methods. This pattern is inconsistent in both the dictionary collections API reference and in other types. I recommend using this across this board, including on the response objects page.

Regarding this, we also need to decide whether the return types should be part of the markdown.
@malandis malandis added bug Something isn't working documentation Improvements or additions to documentation labels Mar 9, 2023
@malandis malandis changed the title Consistent use of markdown inline code Consistent use of markdown inline code for responses Mar 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@NoSQLKnowHow NoSQLKnowHow

Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@NoSQLKnowHow @malandis