You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Currently, sphinx-modeling allows creation of validations. As I understand, this is already possible with needs_warnings. It is probably a bit more verbose than sphinx-modeling, but in the end one can argue that this is a personal preference of syntax.
The real benefit of sphinx-modeling would be when it can create need definitions automatically out of the model definitions. Then there is no more duplication in the form of "classic" need defintions or as needs_warnings for model integrity checks
I read the hint that this is planned. Just wanted to create a placeholder issue for it :)
Is there anything that we can do now with sphinx-modeling, which is not possible with needs_warnings?
Btw, I do appreciate the efforts put it in so far and does not want to take anything away from the nice work.
The text was updated successfully, but these errors were encountered:
Generating the config is a valid request. I will try to find the time to implement it.
For needs_warnings, I see some major differences:
definition phase: defining models with needs_warnings is not just more verbose, it is tedious, complex and from my POV prone to errors as a lot of code is needed in conf.py for things that does pydantic out of the box.
run phase: needs_warnings are emitted on build-finished while sphinx-modeling runs much earlier on doctree-resolved which is a big win for big projects
log phase: needs_warnings prints the filter with the violated needs. sphinx-modeling prints each field with specific validation information what went wrong.
Currently, sphinx-modeling allows creation of validations. As I understand, this is already possible with
needs_warnings
. It is probably a bit more verbose than sphinx-modeling, but in the end one can argue that this is a personal preference of syntax.The real benefit of sphinx-modeling would be when it can create need definitions automatically out of the model definitions. Then there is no more duplication in the form of "classic" need defintions or as
needs_warnings
for model integrity checksI read the hint that this is planned. Just wanted to create a placeholder issue for it :)
Is there anything that we can do now with sphinx-modeling, which is not possible with
needs_warnings
?Btw, I do appreciate the efforts put it in so far and does not want to take anything away from the nice work.
The text was updated successfully, but these errors were encountered: