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

Add documentation to Custom Fit model generated by GCC #2872

Open
butlerpd opened this issue May 4, 2024 · 2 comments
Open

Add documentation to Custom Fit model generated by GCC #2872

butlerpd opened this issue May 4, 2024 · 2 comments
Assignees
Labels
Minor Small job SasView 6.0.0 Required for 6.0.0 release

Comments

@butlerpd
Copy link
Member

butlerpd commented May 4, 2024

The current doc string is not helpful. In particular understanding the two new parameter (volume and swelling) and how to use the model would be very helpful. In fact it may be that some of the documentation in the rst should be moved here? Since the new documentation editor feature now will render the docs for plugins.

@butlerpd butlerpd mentioned this issue May 6, 2024
7 tasks
@krzywon krzywon added the SasView 6.0.0 Required for 6.0.0 release label Jul 30, 2024
@wpotrzebowski
Copy link
Contributor

Is it still the issue?

@butlerpd
Copy link
Member Author

Yes - but minor issue. This is about creating model documentation not writing regular documentation. In other words part of the model.py file. The suggestion is that the template that creates the model from a Debye calculation off of a PDF file could include the usual model documentation at the beginning with some information for the user.

However I would rate this as a low priority compared to everything else.

@butlerpd butlerpd self-assigned this Aug 21, 2024
@butlerpd butlerpd added the Minor Small job label Aug 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Minor Small job SasView 6.0.0 Required for 6.0.0 release
Projects
None yet
Development

No branches or pull requests

3 participants