LLDB. docs. Tutorial: double dash render

Open Beginner friendly
#61,062 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Domain
documentation

Research direction

Open lldb/docs/use/tutorial.rst at the Command Structure section and compare it with the rendered tutorial page. Check the documentation rendering behavior for the -- text, then verify the generated page preserves two hyphens rather than converting them to an en dash.

Written by the indexing model from the issue text.

Description

documentation lldb

Source (https://github.com/llvm/llvm-project/blob/main/lldb/docs/use/tutorial.rst#command-structure):

Options can be placed anywhere on the command line, but if the arguments begin with a "-" then you have to tell lldb that you're done with options for the current command by adding an option termination: "--".

Rendered (https://lldb.llvm.org/use/tutorial.html#command-structure):

Options can be placed anywhere on the command line, but if the arguments begin with a “-” then you have to tell lldb that you’re done with options for the current command by adding an option termination: “–”.

Problem: -- rendered to

Dominant language
LLVM
Stars
40.6k
Forks
18.7k
Avg merge
18h 16m
Merged PRs (30d)
417

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.

More from llvm/llvm-project

All issues in llvm/llvm-project

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.