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
Describe the bug
When editing built-in models, the documentation editor is replaced by the model editor which in principle would allow editing of the c file as well as the python math besides the documentation. However, changes to the documentation do not trigger a document regeneration. I strongly suspect that the math changes do not get updated either. Loading a regular document page and editing it will trigger a regeneration when hitting save, but that regeneration does not appear to affect the built in model documentation.
Expected behavior
There are several approaches that maybe require some discussion.
First we could just remove the edit button on the builtin models docs
Second, we could add a button to the model editor that generates the docs separate from saving. This would allow the user to check their documentation from the model editor (it would be truly annoying for the model docs to get generated every time I change a line of code while debugging my new model).
We make the builtin model docs Edit button link to the standard doc editor window. In this case we probably don't want to suck in the whole file into the editor but just the rst portion (i.e. the top of the file between the two sets of triple quotes)
Something else?
I'm currently thinking the second option is probably the best both for the user and the code structure?
SasView version (please complete the following information):
Version: 6.0.0b1
Operating system (please complete the following information):
OS: Windows 10
The text was updated successfully, but these errors were encountered:
krzywon
added
Blocker
Prevents a different issue from being resolved
and removed
Blocker
Prevents a different issue from being resolved
labels
Aug 26, 2024
Describe the bug
When editing built-in models, the documentation editor is replaced by the model editor which in principle would allow editing of the c file as well as the python math besides the documentation. However, changes to the documentation do not trigger a document regeneration. I strongly suspect that the math changes do not get updated either. Loading a regular document page and editing it will trigger a regeneration when hitting
save
, but that regeneration does not appear to affect the built in model documentation.Expected behavior
There are several approaches that maybe require some discussion.
Edit
button link to the standard doc editor window. In this case we probably don't want to suck in the whole file into the editor but just the rst portion (i.e. the top of the file between the two sets of triple quotes)I'm currently thinking the second option is probably the best both for the user and the code structure?
SasView version (please complete the following information):
Operating system (please complete the following information):
The text was updated successfully, but these errors were encountered: