[docs] Fix various syntax and rendering errors #127062
Conversation
colleenmcginnis
added
>docs
elasticsearchmachine
added
v9.1.0
external-contributor
colleenmcginnis
changed the title
|
Pinging @elastic/es-docs (Team:Docs) |
| @@ -34,7 +34,7 @@ The following numeric types are supported: | |||
| : A floating point number that is backed by a `long`, scaled by a fixed `double` scaling factor. | |||
|
|
|||
| `unsigned_long` | |||
| : An unsigned 64-bit integer with a minimum value of 0 and a maximum value of `2`^`64`^`-1`. | |||
| : An unsigned 64-bit integer with a minimum value of 0 and a maximum value of `2^64 - 1`. | |||
There was a problem hiding this comment.
I think the problem with the superscripts is the pesky backticks?
There was a problem hiding this comment.
So should we change this? If yes, can you provide a suggestion?
There was a problem hiding this comment.
"should" is strong, just pointing out that the superscript syntax won't work when code formatted, not high priority but if you're scripting these changes just a point to note for future :)
There was a problem hiding this comment.
In my opinion we should either format it like this (all inside code like 2^64 - 1) or with no code (just 264 - 1). Which do you prefer?
There was a problem hiding this comment.
Yup fully agreed we should pick one, and I think inside code is good because folks often want numbers to be code formatted so they stand out against the surrounding text
If I was being idiosyncratic and operating in a vacuum I'd probably use no code proper superscripting but bold 😄
leemthompo
added
auto-backport
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
* fix syntax and rendering errors * clean up * fix versions * more clean up * more fixes * more fixes * more fixes (cherry picked from commit 08552f1) # Conflicts: # docs/reference/elasticsearch/mapping-reference/dense-vector.md # docs/reference/elasticsearch/mapping-reference/semantic-text.md
* fix syntax and rendering errors * clean up * fix versions * more clean up * more fixes * more fixes * more fixes (cherry picked from commit 08552f1) # Conflicts: # docs/reference/elasticsearch/mapping-reference/dense-vector.md # docs/reference/elasticsearch/mapping-reference/semantic-text.md Co-authored-by: Colleen McGinnis <[email protected]>
Fixes various syntax and rendering errors that might include:
codeformatting in dropdown titles)deprecated:[8.15.0]became[8.15.0], which doesn't give any information about what happened in 8.15.0)9.0.0versions