Skip to content

[8pt] Update formatting in "Binary protocol" #1801

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
Closed
NickVolynkin opened this issue Feb 3, 2021 · 1 comment · Fixed by #1842
Closed

[8pt] Update formatting in "Binary protocol" #1801

NickVolynkin opened this issue Feb 3, 2021 · 1 comment · Fixed by #1842
Assignees
@xuniq
Labels
formatting Change formatting

Comments

@NickVolynkin
Copy link
Contributor

NickVolynkin commented Feb 3, 2021 •
edited
Loading

A follow-up of #1661. Use code-block to format code examples. Improve other things that can be improved.

Reference on markup syntax: https://www.tarantool.io/ru/doc/latest/contributing/docs/markup/#code-snippets

For example, change:

IPROTO_SELECT=0x01, IPROTO_INSERT=0x02, IPROTO_REPLACE=0x03,...

to

IPROTO_SELECT=0x01
IPROTO_INSERT=0x02
IPROTO_REPLACE=0x03
...

For the latter, use .. code-block:: ini.
@NickVolynkin NickVolynkin added the formatting Change formatting label Feb 3, 2021
@NickVolynkin NickVolynkin changed the title Update formatting in "Binary protocol" [4pt] Update formatting in "Binary protocol" Feb 12, 2021
@NickVolynkin NickVolynkin mentioned this issue Feb 16, 2021
Closed
xuniq added a commit that referenced this issue Feb 18, 2021
@xuniq
fixes gh-1801 fix formatting for box_protocol.rst
9d1663e
@NickVolynkin NickVolynkin linked a pull request Feb 18, 2021 that will close this issue
fixes gh-1801 fix formatting for box_protocol.rst #1842
Merged
@pgulutzan
Copy link
Contributor

If you use a browser to look at the .html that is produced from the latest commit, and search for grave accent (backtick) `, it will show you a few errors.

xuniq added a commit that referenced this issue Feb 19, 2021
@xuniq
fixes gh-1801 fixed indents for box_protocol.rst
c27bd70
xuniq added a commit that referenced this issue Feb 20, 2021
@xuniq
fixes gh-1801 fixed highlightning for replaceable code in box_protoco…
e44900a 
…l.rst
xuniq added a commit that referenced this issue Feb 20, 2021
@xuniq
fixes gh-1801 fixed typos with backticks in box_protocol.rst
29b56cc
@NickVolynkin NickVolynkin changed the title [4pt] Update formatting in "Binary protocol" [8pt] Update formatting in "Binary protocol" Feb 24, 2021
NickVolynkin pushed a commit that referenced this issue Feb 24, 2021
@xuniq @NickVolynkin
fixes gh-1801 formatting box_protocol.rst
0e9dfb1 
* fixed indents
* fixed highlightning for replaceable
* fixed typos with backticks
NickVolynkin pushed a commit that referenced this issue Feb 24, 2021
@xuniq
fixes gh-1801 fix formatting for box_protocol.rst (#1842)
a3f6c57 
* fixed indents
* fixed highlightning for replaceable
* fixed typos with backticks

Reviewed and co-authored-by: Nick Volynkin <[email protected]>

* Proofread changes, fix indentation in code blocks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@xuniq xuniq

Labels
formatting Change formatting
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fixes gh-1801 fix formatting for box_protocol.rst tarantool/doc
3 participants
@pgulutzan @NickVolynkin @xuniq