Opened 2 years ago

Closed 2 months ago

#883 closed enhancement (fixed)

Add link to source code of each model to model documentation

Reported by: ajj Owned by: smk78
Priority: minor Milestone: SasView 4.3.0
Component: sasmodels Keywords:
Cc: Work Package: SasView Documentation

Description

The documentation for each model distributed in sasmodels should have a link to the source code on github, ideally to the revision that ships.

This will make it easier for users to find the source code to base their own models on without having to dig through the distributed packages.

Change History (5)

comment:1 Changed 2 years ago by richardh

If the docs had an appropriate instruction and/or a pointer, and also a big note in the plugins directory, is it that hard to find the directory where the source code from the download lives? (On my windows, program files(x86)/sasview41/sasmodels-data/models) This works without web access to github and is the correct revision for my download.

OK the user might discover, I think, that they can add or modify models there without using their plugins directory, so we might want to ban that?

comment:2 Changed 2 years ago by pkienzle

Or provide a "clone existing model" button in the plugin editor window?

comment:3 Changed 19 months ago by butler

  • Milestone changed from SasView 4.2.0 to SasView 4.3.0

comment:4 Changed 2 months ago by smk78

Replying to http://trac.sasview.org/ticket/883#comment:1 :
The start of plugin.rst actually says:

The built-in modules are available in the models subdirectory of the sasmodels package. 
For SasView on Windows, these will be found in C:\Program Files (x86)\SasView\sasmodels-
data\models. On Mac OSX, these will be within the application bundle as /Applications/
SasView 4.0.app/Contents/Resources/sasmodels-data/models.

comment:5 Changed 2 months ago by smk78

  • Owner set to smk78
  • Resolution set to fixed
  • Status changed from new to closed

In 0507e09b26f5789862db8a175d64657cf4f3b829/sasmodels:

Added link to source code to each model. Closes #883

Note: See TracTickets for help on using tickets.