Improve `--help` documentation for `--start-group` and `--end-group`

Open Beginner friendly
#1,743 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
cpp
Domain
cli, documentation

Research direction

Search the repository for the current --start-group and --end-group help strings, then read the surrounding help-generation entry point. Update both descriptions to explain that archives are searched iteratively until no new undefined symbols are created. Done means the --help output clearly includes this behavior for both options.

Written by the indexing model from the issue text.

Description

documentation good first issue not-planned

Currently, the docs for these two options are:

 --start-group           Start a group
 --end-group             End a group

Perhaps we can improve this to something like:

--start-group    archives within --start-group and --end-group are searched 
                         iteratively until no new undefined symbols are created
--end-group    archives within --start-group and --end-group are searched 
                        iteratively until no new undefined symbols are created
Dominant language
C++
Stars
259
Forks
84
Avg merge
2d 8h
Merged PRs (30d)
76

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 qualcomm/eld

All issues in qualcomm/eld

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.