robotframework / robotframework/RIDE

Preprocess important `robot` BuiltIn variables to be usable in documentation imports

Open
#1,947 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement prio-medium
Dominant language
Python
Stars
1k
Forks
385
Avg merge
13m
Merged PRs (30d)
2

Description

In the below example, the ${CURDIR} will be only defined when robotis running, this causes the library import to fail and the keyword documentation is not loaded.
(Implementation suggestion: Use robot --dryrun libraries call to obtain variables)

Related with #1609, where it is requested that the arguments for TestRunner be preprocessed, overriding existing variables.

image

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

The issue gives no file or test entry point; begin by reproducing the ${CURDIR} library-import failure described in the issue and inspect how RIDE loads keyword documentation. Compare the suggested robot --dryrun library call with the current import path; done means imports using built-in variables load their keyword documentation without requiring a normal run.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.