-
Notifications
You must be signed in to change notification settings - Fork 12.1k
server : update json snippets in README.md [no ci] #11492
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
Conversation
IMO we should not mark this as On github, invalid javascript may not render as invalid syntax (highlighted in red), but will do somewhere else. So the best way is to simply remove the |
This commit updates some of JSON snippets in README.md file and removes the `json` language tag from the code blocks. The motivation for this changes is that if there is invalid json in a code snippet these are highlighted in red which can make it somewhat difficult to read and can be a little distracting.
e227845
to
fdf735e
Compare
As an alternative proposal, we could switch the language tag to Current [
{
"index": 0,
"embedding": [
[ ... embeddings for token 0 ... ],
[ ... embeddings for token 1 ... ],
[ ... ]
[ ... embeddings for token N-1 ... ],
]
},
...
{
"index": P,
"embedding": [
[ ... embeddings for token 0 ... ],
[ ... embeddings for token 1 ... ],
[ ... ]
[ ... embeddings for token N-1 ... ],
]
}
] New [
{
"index": 0,
"embedding": [
// [ ... embeddings for token 0 ... ],
// [ ... embeddings for token 1 ... ],
// [ ... ]
// [ ... embeddings for token N-1 ... ],
]
},
// ...
{
"index": "P",
"embedding": [
// [ ... embeddings for token 0 ... ],
// [ ... embeddings for token 1 ... ],
// [ ... ]
// [ ... embeddings for token N-1 ... ],
]
}
] |
@isaac-mcfadyen Thanks for the suggestion about json with comments! I'll opt on the side of caution and not use a language tag to avoid any rendering issues if |
This commit updates some of JSON snippets in README.md file and removes the `json` language tag from the code blocks. The motivation for this changes is that if there is invalid json in a code snippet these are highlighted in red which can make it somewhat difficult to read and can be a little distracting.
This commit updates some of JSON snippets in README.md file and removes the `json` language tag from the code blocks. The motivation for this changes is that if there is invalid json in a code snippet these are highlighted in red which can make it somewhat difficult to read and can be a little distracting.
This commit updates some of JSON snippets in README.md file and removes the `json` language tag from the code blocks. The motivation for this changes is that if there is invalid json in a code snippet these are highlighted in red which can make it somewhat difficult to read and can be a little distracting.
This commit updates some of JSON snippets in README.md file and
removes the
json
language tag from the code blocks.The motivation for this changes is that if there is invalid json in a
code snippet these are highlighted in red which can make it somewhat
difficult to read and can be a little distracting. This can be seen here