Skip to content

[ENHANCEMENT] Add folding support for Documentation sections #463

Open
@LucianCrainic

Description

@LucianCrainic

Add folding support for Documentation sections

Currently, RobotCode provides folding functionality for various elements in Robot Framework files such as testcases, keywords, sections, for loops, etc. However, the [Documentation] section within test cases and keywords doesn't have dedicated folding support.

When writing Robot Framework test cases with extensive documentation, the [Documentation] sections can become quite large. Being able to fold these sections would improve readability and navigation in test files, especially when focusing on the test steps rather than documentation.

Currently, the folding_range.py implementation includes folding for:

    Sections
    Test Cases
    Keywords
    For Loops
    If/Else blocks
    While loops
    Try blocks

But there is no specific folding support for the Documentation sections within test cases or keywords.

Add the ability to fold [Documentation] sections separately from their parent test case or keyword, allowing users to collapse documentation text while still seeing the test steps.

When reviewing or working with test files that have extensive documentation, being able to fold just the documentation sections would make navigation and readability much better.

This would likely require adding a new visit method in the _Visitor class in folding_range.py to handle Documentation sections specifically, similar to how other elements are handled.

This feature would be especially helpful for teams that follow a documentation-heavy approach to test development.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions