tarantool / tarantool/doc

[0pt] Inline code in Lua-generated docs is parsed in different ways

Open
#2,451 0 comments 0 reactions 1 assignee View on GitHub

@artembo is already working on this.

Since Nov 19, 2021.

internal
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

What needs to be done

Some of the documentation (like Cartridge) is generated from Lua files. Looks like entities in single backticks are sometimes parsed as cursive and other times as inline code. They should be always parsed as inline code.

Here is an illustration. Both ".yaml" and the parts formatted in cursive are framed by single backticks in the source, https://github.com/tarantool/cartridge/blob/master/cartridge/argparse.lua:
image

Reviewer: @ patiencedaur

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.