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

Documentation Editor Does not updated changes to built-in model docs #2972

Closed
butlerpd opened this issue Jul 19, 2024 · 0 comments · Fixed by #3088
Closed

Documentation Editor Does not updated changes to built-in model docs #2972

butlerpd opened this issue Jul 19, 2024 · 0 comments · Fixed by #3088
Assignees
Labels
SasView 6.0.0 Required for 6.0.0 release

Comments

@butlerpd
Copy link
Member

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
@krzywon krzywon added the SasView 6.0.0 Required for 6.0.0 release label Jul 22, 2024
@tsole0 tsole0 self-assigned this Aug 20, 2024
@tsole0 tsole0 linked a pull request Aug 22, 2024 that will close this issue
7 tasks
@krzywon krzywon added Blocker Prevents a different issue from being resolved and removed Blocker Prevents a different issue from being resolved labels Aug 26, 2024
@krzywon krzywon closed this as completed Sep 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
SasView 6.0.0 Required for 6.0.0 release
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants