Skip to content

Conversation

@tristan-f-r
Copy link
Collaborator

@tristan-f-r tristan-f-r commented Oct 23, 2025

It was marked as deprecated.

@tristan-f-r tristan-f-r added easy PRs which take at most a minute to review with little thinking. refactor Changes that don't actually improve anything except for code quality. labels Oct 23, 2025
@read-the-docs-community
Copy link

read-the-docs-community bot commented Oct 23, 2025

Documentation build overview

📚 spras | 🛠️ Build #30060534 | 📁 Comparing 3d2a29d against latest (615e6fb)


🔍 Preview build

Show files changed (3 files in total): 📝 3 modified | ➕ 0 added | ➖ 0 deleted
File Status
genindex.html 📝 modified
fordevs/spras.config.html 📝 modified
fordevs/spras.html 📝 modified

@ntalluri
Copy link
Collaborator

ntalluri commented Oct 24, 2025

We were keeping this incase people somehow were still using old configs that had the directed setting.

@tristan-f-r
Copy link
Collaborator Author

tristan-f-r commented Oct 24, 2025

We already broke old configs in #292. SPRAS is also not stable software.

@agitter
Copy link
Collaborator

agitter commented Oct 24, 2025

Now if I provide an old config file I get

TypeError in file "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\Snakefile", line 21:
'bool' object is not iterable
  File "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\Snakefile", line 21, in <module>
  File "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\spras\config\config.py", line 35, in init_global
  File "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\spras\config\config.py", line 114, in __init__
  File "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\spras\config\config.py", line 313, in process_config
  File "C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\spras\config\config.py", line 186, in process_algorithms

Previously I would get

C:\Users\agitter\Desktop\madison\collaborators\Ritz\spras\spras\config\config.py:316: UserWarning: UPDATE: we no longer use the directed key in the config file
  self.process_algorithms(raw_config)

and the workflow would run.

I agree we don't want to be too tethered to backwards compatibility, but the unintelligible error message is much worse than the user-friendly warning.

@tristan-f-r
Copy link
Collaborator Author

tristan-f-r commented Oct 24, 2025

I am always in favor of better error messages (including in this case), and we can (and do!) provide better error messages in general with #321, since we'll know in advance what algorithms support what keys.

I agree we don't want to be too tethered to backwards compatibility, but the unintelligible error message is much worse than the user-friendly warning.

Especially since we currently get this with any typo of algorithm parameters.

@agitter
Copy link
Collaborator

agitter commented Oct 24, 2025

If #329 will solve the general case, I would wait to merge this until that is ready.

@tristan-f-r
Copy link
Collaborator Author

#329 removes directed anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

easy PRs which take at most a minute to review with little thinking. refactor Changes that don't actually improve anything except for code quality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants