Skip to content

Link rules with Style Guide #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bhirsz opened this issue Jun 17, 2024 · 1 comment
Open

Link rules with Style Guide #1095

bhirsz opened this issue Jun 17, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@bhirsz
Copy link
Member

bhirsz commented Jun 17, 2024

Robot Framework Style Guide links some of its recommendation with our rules. It may be good idea to enhance our rules documentation with links to Style Guide whenever our rule covers given part of the Style Guide.

@bhirsz bhirsz added the documentation Improvements or additions to documentation label Jun 17, 2024
@bhirsz
Copy link
Member Author

bhirsz commented Mar 11, 2025

Implemented in #1307 - some rules may be linked later after rule behaviour change etc. But there is basic setup in place for linking and displaying in our docs.

We now need do the same with formatters (if it makes sense) and cross reference in style guide as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant