MarketSquare / MarketSquare/robotframework-style-guide

Updating Vertical order with the Name setting

Open
#70 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

style-guide
Dominant language
RobotFramework
Stars
29
Forks
5
PR merge metrics
No merged PRs in 30d

Description

There is a Name setting available in the *** Settings *** section.

as per [Name Setting in Robot Framework 6.1](https://github.com/robotframework/robotframework/issues/4583)

It would make sense to update the Vertical Order of the Setting section:

```robot
*** Settings ***
Name Name of Suite
Documentation This is documentation
```

Contributor guide

No contributing guide indexed for this repository

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 with the style guide's documented ordering for the Robot Framework Settings section and review the linked Robot Framework 6.1 Name setting issue. Done means the ordering places Name before Documentation, matching the example in this issue.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.