Updated explanation for Keyword Matching (3.3.2) and examples for Free Named Arguments (2.5.1.2) by bennyvw · Pull Request #80 · robotframework/robotframework-RFCP-syllabus

bennyvw · 2026-03-02T15:44:00Z

Important note: the image of the keyword documentation of the Set To Dictionary keyword has to be changed. I did not know how to create the 'splitted' image with the waves in between, so please help me out on that.

Checklist

Label set: impact:major or impact:minor
PR title contains: Subject + Chapter scope + Topic
One bullet per issue/change (see “Issues”)
Each bullet includes a chapter (Ch. X or Ch. X.Y)
Uses imperative verbs (Fix / Remove / Rephrase / Clarify)
Descriptions are short (3–10 words)

Major change checklist

Exam Committee reviewed and confirmed exam impact (link/note):
Training Providers informed (date + link):
Effective date (countdown ends): YYYY-MM-DD

Issues

(Ch. 2.5.1.2) Update Free Named Arguments Section After Change in Process Library #74 Run Process examples in paragraph 2.5.1.2 replaced by Set To Dictionary
(Ch. 3.3.2) The keyword matching logic RF <7.1 has been changed #77 Explanation on how keyword matching works changed to reflect new functionality

Herewith issues and are solved.

Copilot

Pull request overview

Updates the syllabus documentation to reflect Robot Framework’s updated keyword matching behavior (RF 7.1+) and replaces outdated Run Process examples (affected by Process library changes) with Set To Dictionary examples.

Changes:

Replaced the chapter 2 keyword interface example keyword from Run Process to Set To Dictionary, including updated examples for varargs and free-named-args usage.
Updated the chapter 3 keyword matching algorithm description to reflect the new BDD-prefix handling behavior.
Added a new screenshot asset for Set To Dictionary keyword documentation.

Reviewed changes

Copilot reviewed 2 out of 4 changed files in this pull request and generated 2 comments.

File	Description
website/docs/chapter-02/05_keyword_interface.md	Switches the example keyword to `Set To Dictionary`, updates varargs/free-named-args explanations and examples, and updates the referenced screenshot.
website/docs/chapter-03/03_user_keyword.md	Updates the described keyword matching algorithm order (BDD prefixes vs full match).
website/static/img/Set_To_Dictionary_part_1.png	Adds the new screenshot used by chapter 2.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-02T15:48:14Z

website/docs/chapter-02/05_keyword_interface.md


-This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/03_user_keyword.md)"} `command` which can be called positionally or by name.
-The latter two arguments are optional.
+This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/user_keyword#3351-defining-mandatory-arguments)"} `dictionary` which can be called positionally or by name.


The tooltip link target chapter-03/user_keyword#3351-defining-mandatory-arguments doesn’t match the internal linking convention used elsewhere in the docs (e.g., chapter-03/03_user_keyword.md#...) and is likely a broken link. Update it to point to the actual user keyword chapter file/anchor used in the rest of the syllabus.

Suggested change

This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/user_keyword#3351-defining-mandatory-arguments)"} `dictionary` which can be called positionally or by name.

This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/03_user_keyword.md#3351-defining-mandatory-arguments)"} `dictionary` which can be called positionally or by name.

website/docs/chapter-02/05_keyword_interface.md

bennyvw · 2026-03-02T17:16:25Z

website/docs/chapter-02/05_keyword_interface.md


-This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/03_user_keyword.md)"} `command` which can be called positionally or by name.
-The latter two arguments are optional.
+This keyword has one :term[Mandatory Arguments]{tooltipMd="An **Argument** that must be set.<br/>See [Mandatory Args](chapter-03/user_keyword)"} `dictionary` which can be called positionally or by name.


The link chapter-03/03_user_keyword.md led to a 404..

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

GerwinLaagland · 2026-03-02T17:47:29Z

So had a quick look as to why this seems to fail. The code checks the headers that are expected to be updated for the readme file:

2.5.1 Documented Keyword Information
- LO-2.5.1 (K1) Recall the information that can be found in a keyword documentation.
- 2.5.1.1 Example Keyword Should Be Equal``
- 2.5.1.2 Example Keyword Run Process``
- 2.5.1.3 Example Keyword Get Regexp Matches``

This repo has a few files that are generated automatically from the documentation (most visibly the Table of Contents in README.md).

When headings in the docs change, a script rebuilds the numbering and the TOC so everything stays consistent. The GitHub workflow runs that script on every PR. If the script detects that it would update any generated file, it fails the check to signal:

“Some generated files weren’t regenerated and committed yet.”

In this PR, the script shows a diff for README.md, meaning the README TOC is currently out of sync with the docs.

How to fix

Please regenerate the generated files locally and commit the results:

python tools/gen_numbering.py

Then commit whatever files changed (often README.md, and sometimes a few others updated by the script) and push the commit to this PR.

Once the regenerated output is committed, the CI check should pass. (Thanks ChatGPT for helping me out. 😅)

github-actions · 2026-03-02T20:58:31Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T11:14:22Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T11:29:16Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T12:05:27Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T12:07:34Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T12:07:49Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T12:07:51Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2026-03-04T20:44:24Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-80.surge.sh/robotframework-RFCP-syllabus/

bennyvw added 2 commits March 2, 2026 16:36

Run Process examples replaced by Set To Dictionary

d7ebff4

Explanation of keyword matching changed to reflect actual functionality

910f97e

bennyvw requested review from a team, GerwinLaagland, Snooz82 and Copilot March 2, 2026 15:44

Copilot started reviewing on behalf of bennyvw March 2, 2026 15:44 View session

Copilot AI reviewed Mar 2, 2026

View reviewed changes

changed link in tooltip

a577c4f

GerwinLaagland reviewed Mar 2, 2026

View reviewed changes

Update website/docs/chapter-02/05_keyword_interface.md

0778c06

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Updated readme with new paragraph header

b4d61d9

bennyvw temporarily deployed to preview March 2, 2026 20:58 — with GitHub Actions Inactive

GerwinLaagland added the impact: major Substantive; triggers the major-change workflow label Mar 4, 2026

GerwinLaagland temporarily deployed to preview March 4, 2026 11:14 — with GitHub Actions Inactive

GerwinLaagland temporarily deployed to preview March 4, 2026 11:28 — with GitHub Actions Inactive

GerwinLaagland temporarily deployed to preview March 4, 2026 12:05 — with GitHub Actions Inactive

GerwinLaagland had a problem deploying to preview March 4, 2026 12:05 — with GitHub Actions Failure

GerwinLaagland changed the title ~~Updated explanation and examples~~ Updated explanation for Keyword Matching (3.3.2) and examples for Free Named Arguments (2.5.1.2) Mar 4, 2026

GerwinLaagland temporarily deployed to preview March 4, 2026 12:07 — with GitHub Actions Inactive

GerwinLaagland had a problem deploying to preview March 4, 2026 12:07 — with GitHub Actions Failure

GerwinLaagland temporarily deployed to preview March 4, 2026 12:07 — with GitHub Actions Inactive

GerwinLaagland had a problem deploying to preview March 4, 2026 12:07 — with GitHub Actions Failure

GerwinLaagland temporarily deployed to preview March 4, 2026 12:07 — with GitHub Actions Inactive

GerwinLaagland modified the milestone: 1.0.2 Mar 4, 2026

GerwinLaagland deployed to preview March 4, 2026 20:43 — with GitHub Actions View deployment

	This keyword has one :term[Mandatory Arguments]{tooltipMd="An Argument that must be set.<br/>See [Mandatory Args](chapter-03/user_keyword#3351-defining-mandatory-arguments)"} `dictionary` which can be called positionally or by name.
	This keyword has one :term[Mandatory Arguments]{tooltipMd="An Argument that must be set.<br/>See [Mandatory Args](chapter-03/03_user_keyword.md#3351-defining-mandatory-arguments)"} `dictionary` which can be called positionally or by name.

Conversation

bennyvw commented Mar 2, 2026 • edited by GerwinLaagland Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Major change checklist

Issues

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

This comment was marked as resolved.

Uh oh!

bennyvw Mar 2, 2026

Choose a reason for hiding this comment

Uh oh!

GerwinLaagland commented Mar 2, 2026

How to fix

Uh oh!

github-actions bot commented Mar 2, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

github-actions bot commented Mar 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

bennyvw commented Mar 2, 2026 •

edited by GerwinLaagland

Loading