snakemake / snakemake/snakemake

More descriptive error message for AmbiguousRuleException and update Documentation: Ruleorder

Open
#2,893 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement stale
Dominant language
Python
Stars
2.9k
Forks
656
Avg merge
4d 12h
Merged PRs (30d)
9

Description

Is your feature request related to a problem? Please describe.
When getting this error, the current error states

Consider starting rule output with a unique prefix, constrain your wildcards, or use the ruleorder directive.

My first instict would be to add the ruleorder directive under the involved rules. Unfortunately this yields a SyntaxError

Unexpected keyword ruleorder in rule definition

Describe the solution you'd like
When looking up ruleorder in the documentation it is not clearly stated that it's supposed to be placed outside the rule defination. Consider tweaking the AmbiguousRuleException message, so that it's specified to define the ruleorder at top level.
Definately make sure to update the documentation on that ruleorder should be placed outside the rule.

Describe alternatives you've considered
More coding heavy: Make a ruleorder exception for the rules, which detects the ruleorder keyword, and thus provides a specific error message on its usage.

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 by locating AmbiguousRuleException and the documentation section for ruleorder. Check how the current error text is assembled and how the directive is described, then update the message and documentation so its required top-level placement is explicit. Verify the related error and documentation checks if the project provides them.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.