Skip to content
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

Feat/explicitly define help url for each rule #1138

Open
wants to merge 17 commits into
base: master
Choose a base branch
from

Conversation

Lakitna
Copy link
Contributor

@Lakitna Lakitna commented Nov 2, 2024

Closes #1123

This is a proof of concept for explicitly defining the help URL for each rule. This approach will require all default and community rules to be extended with a URL.

Fixes rule help URLs for community rules and custom rules. URLs are now defined per rule instead of globally.

This is a backward compatible change.

robocop/checkers/comments.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Nov 11, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.93%. Comparing base (f62508c) to head (5fb7f77).
Report is 43 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1138      +/-   ##
==========================================
- Coverage   97.02%   96.93%   -0.09%     
==========================================
  Files          37       39       +2     
  Lines        4670     5030     +360     
==========================================
+ Hits         4531     4876     +345     
- Misses        139      154      +15     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@Lakitna
Copy link
Contributor Author

Lakitna commented Nov 11, 2024

Still needs a bit of testing, but otherwise done :)

@Lakitna Lakitna requested a review from bhirsz November 14, 2024 16:28
@Lakitna
Copy link
Contributor Author

Lakitna commented Nov 14, 2024

This PR is ready for review :)

Copy link
Member

@bhirsz bhirsz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I apologise for delay. I was conflicted with the topics because of the new ideas:

bhirsz/robotframework-cop-academy#33

I'm also refactoring defining the rules in new robocop heavily: https://github.com/bhirsz/robotframework-cop-academy/tree/feature/refactor_rules

That's why I was conflicted with introducing such breaking change, and then another. How do you feel about possibly postponing it, is it something you want sooner than later? Alternatively we can ignroe community rules for now (since they will be removed), and rename "DefaultRule" to "Rule" like in the beginning (sorry for the extra work). All the result may stay - in that case we will still have option to overwrite help url by creating own class but without any breaking change.

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

Successfully merging this pull request may close these issues.

[Bug] Help URL for custom rules links to Robocop docs
2 participants