robotframework / robotframework/robotframework

Embedded argument support for examples in libdoc

Open
#5,140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
11.9k
Forks
2.6k
Avg merge
1d 18h
Merged PRs (30d)
10

Description

When writing examples using libdoc, you typically want to use concrete examples with clarifying arguments. However, when you do that using embedded arguments, libdoc can no longer link the keyword to its definition.

Consider this snippet. The keyword from the example is not being linked:

@keyword("Shout ${n} cheers for")
def hurray(self, n:int, person:str):
    """Cheer them on as much as you like!
    
    Example:
    | `Shout 3 cheers for` | Robot |
    """

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.

Research direction

Start by reproducing the supplied Python example through the libdoc entry point, focusing on the embedded argument in Shout 3 cheers for. Trace how the example keyword is resolved against the @keyword definition. Done means libdoc links the embedded-argument example to its keyword definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation, tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.