Changes between Version 9 and Version 10 of Documentation Checks


Ignore:
Timestamp:
Mar 16, 2016 7:03:17 PM (9 years ago)
Author:
butler
Comment:

—

Legend:

Unmodified
Added
Removed
Modified

  • Documentation Checks

    v9 v10  
    6868---- 
    6969 
    70 '''This table indicates the status of documentation compliance with the above rules (N = not compliant / . = status pending):''' 
     70'''This table indicates the status of documentation compliance with the above rules (Y = compliant / . = status pending):''' 
    7171 
    72 ||=!SasView name=||=sasmodels name=||= short_desc =||= param_table =||= long_desc =||= definition =||= formula =||= param_desc =||= plot =||= ref =||= attribution =|| 
    73 ||HayterMSAStructure       ||hayter_msa         ||.||.||.||.||.||.||.||.||.|| 
    74 ||!BarBellModel            ||barbell            ||.||.||.||.||.||.||.||.||.|| 
    75 ||BCCrystalModel           ||bcc                ||.||.||.||.||.||.||.||.||.|| 
    76 ||BEPolyelectrolyte        ||be_polyelectrolyte ||.||.||.||.||.||.||.||.||.|| 
    77 ||!BroadPeakModel          ||broad_peak         ||.||.||.||.||.||.||.||.||.|| 
    78 ||!CappedCylinderModel     ||capped_cylinder    ||.||.||.||.||.||.||.||.||.|| 
    79 ||!CoreShellBicelleModel   ||core_shell_bicelle ||.||.||.||.||.||.||.||.||.|| 
    80 ||!CoreShellCylinderModel  ||core_shell_cylinder||.||.||.||.||.||.||.||.||.|| 
    81 ||!CoreShellEllipsoidModel||core_shell_ellipsoid||.||.||.||.||.||.||.||.||.|| 
    82 ||CoreShellEllipsoidXTModel||core_shell_ellipsoid_xt||.||.||.||.||.||.||.||.||.|| 
    83 ||!CoreShellModel          ||core_shell_sphere  ||.||.||.||.||.||.||.||.||.|| 
    84 ||!CorrLength              ||correlation_length ||.||.||.||.||.||.||.||.||.|| 
    85 ||CSParallelepipedModel    ||core_shell_parallelepiped||.||.||.||.||.||.||.||.||.|| 
    86 ||!CylinderModel           ||cylinder           ||.||.||.||.||.||.||.||.||.|| 
    87 ||DABModel                 ||dab                ||.||.||.||.||.||.||.||.||.|| 
    88 ||!EllipsoidModel          ||ellipsoid          ||.||.||.||.||.||.||.||.||.|| 
    89 ||!EllipticalCylinderModel ||elliptical_cylinder||.||.||.||.||.||.||.||.||.|| 
    90 ||FCCrystalModel           ||fcc                ||.||.||.||.||.||.||.||.||.|| 
    91 ||!FlexibleCylinderModel   ||flexible_cylinder  ||.||.||.||.||.||.||.||.||.|| 
    92 ||FlexCylEllipXModel      ||flexible_cylinder_ex||.||.||.||.||.||.||.||.||.|| 
    93 ||!FractalCoreShell        ||fractal_core_shell ||.||.||.||.||.||.||.||.||.|| 
    94 ||!FuzzySphereModel        ||fuzzy_sphere       ||.||.||.||.||.||.||.||.||.|| 
    95 ||!PeakGaussModel          ||gaussian_peak      ||.||.||.||.||.||.||.||.||.|| 
    96 ||!GaussLorentzGel         ||gauss_lorentz_gel  ||.||.||.||.||.||.||.||.||.|| 
    97 ||!GelFitModel             ||gel_fit            ||.||.||.||.||.||.||.||.||.|| 
    98 ||Guinier                  ||guinier            ||.||.||.||.||.||.||.||.||.|| 
    99 ||!GuinierPorod            ||guinier_porod      ||.||.||.||.||.||.||.||.||.|| 
    100 ||!HardsphereStructure     ||hardsphere         ||.||.||.||.||.||.||.||.||.|| 
    101 ||!HollowCylinderModel     ||hollow_cylinder    ||.||.||.||.||.||.||.||.||.|| 
    102 ||!LamellarModel           ||lamellar           ||.||.||.||.||.||.||.||.||.|| 
    103 ||LamellarPSModel          ||lamellarCaille     ||.||.||.||.||.||.||.||.||.|| 
    104 ||LamellarPSHGModel        ||lamellarCailleHG   ||.||.||.||.||.||.||.||.||.|| 
    105 ||LamellarFFHGModel        ||lamellarFFHG       ||.||.||.||.||.||.||.||.||.|| 
    106 ||LamellarPCrystallModel   ||lamellarPC         ||.||.||.||.||.||.||.||.||.|| 
    107 ||!LineModel               ||line               ||.||.||.||.||.||.||.||.||.|| 
    108 ||!LinearPearlsModel       ||linear_pearls      ||.||.||.||.||.||.||.||.||.|| 
    109 ||Lorentz                  ||lorentz            ||.||.||.||.||.||.||.||.||.|| 
    110 ||!MassFractalModel        ||mass_fractal       ||.||.||.||.||.||.||.||.||.|| 
    111 ||!MassSurfaceFractal     ||mass_surface_fractal||.||.||.||.||.||.||.||.||.|| 
    112 ||!MicelleSphCore          ||micelle_sphere_core||.||.||.||.||.|| ||.||.||.|| 
    113 ||!MultiShellModel         ||multi_shell        ||.||.||.||.||.||.||.||.||.|| 
    114 ||!ParallelepipedModel     ||parallelepiped     ||.||.||.||.||.||.||.||.||.|| 
    115 ||!PeakLorentzModel        ||peak_lorentz       ||.||.||.||.||.||.||.||.||.|| 
    116 ||!PearlNecklaceModel      ||pearl_necklace     ||.||.||.||.||.||.||.||.||.|| 
    117 ||!PolyExclVolume          ||polymer_excl_volume||.||.||.||.||.||.||.||.||.|| 
    118 ||!PorodModel              ||porod              ||.||.||.||.||.||.||.||.||.|| 
    119 ||!AbsolutePower_Law       ||power_law          ||.||.||.||.||.||.||.||.||.|| 
    120 ||!RectangularPrismModel   ||rectangular_prism  ||.||.||.||.||.||.||.||.||.|| 
    121 ||!RectangularHollowPrismModel||hollow_rectangular_prism||.||.||.||.||.||.||.||.||.|| 
    122 ||!RectangularHollowPrismInfThinWallsModel||hollow_rectangular_prism_infinitely_thin_walls ||.||.||.||.||.||.||.||.||.|| 
    123 ||SCCrystalModel           ||sc_crystal         ||.||.||.||.||.||.||.||.||.|| 
    124 ||!SphereModel             ||sphere             ||.||.||.||.||.||.||.||.||.|| 
    125 ||!StackedDisksModel       ||stacked_disk       ||.||.||.||.||.||.||.||.||.|| 
    126 ||!StarPolymer             ||star_polymer       ||.||.||.||.||.||.||.||.||.|| 
    127 ||StickyHSStructure        ||stickyhardsphere   ||.||.||.||.||.||.||.||.||.|| 
    128 ||!SurfaceFractalModel     ||surface_fractal    ||.||.||.||.||.||.||.||.||.|| 
    129 ||!TeubnerStrey            ||teubner_strey      ||.||.||.||.||.||.||.||.||.|| 
    130 ||!TriaxialEllipsoidModel  ||triaxial_ellipsoid ||.||.||.||.||.||.||.||.||.|| 
    131 ||!TwoLorentzian           ||two_lorentzian     ||.||.||.||.||.||.||.||.||.|| 
    132 ||!TwoPowerLaw             ||two_power_law      ||.||.||.||.||.||.||.||.||.|| 
    133 ||!VesicleModel            ||vesicle            ||.||.||.||.||.||.||.||.||.|| 
    134 ||BinaryHSModel            ||binary_hard_sphere ||.||.||.||.||.||.||.||.||.|| 
    135 ||Core2ndMomentModel       ||adsorbed_layer     ||.||.||.||.||.||.||.||.||.|| 
    136 ||!CoreMultiShellModel     ||                   ||.||.||.||.||.||.||.||.||.|| 
    137 ||Debye                    ||mono_gauss_coil    ||.||.||.||.||.||.||.||.||.|| 
    138 ||!FractalModel            ||                   ||.||.||.||.||.||.||.||.||.|| 
    139 ||!MultiplicationModel     ||                   ||.||.||.||.||.|| ||.||.||.|| 
    140 ||!OnionExpShellModel      ||                   ||.||.||.||.||.||.||.||.||.|| 
    141 ||Poly_GaussCoil           ||poly_gauss_coil    ||.||.||.||.||.||.||.||.||.|| 
    142 ||!PringleModel            ||                   ||.||.||.||.||.||.||.||.||.|| 
    143 ||!RaspBerryModel          ||                   ||.||.||.||.||.||.||.||.||.|| 
    144 ||!ReflectivityModel       ||                   ||.||.||.||.||.||.||.||.||.|| 
    145 ||ReflectivityIIModel      ||                   ||.||.||.||.||.||.||.||.||.|| 
    146 ||RPA10Model               ||                   ||.||.||.||.||.||.||.||.||.|| 
    147 ||SphericalSLDModel        ||                   ||.||.||.||.||.||.||.||.||.|| 
    148 ||!SquareWellStructure     ||squarewell         ||.||.||.||.||.||.||.||.||.|| 
    149 ||!UnifiedPowerRg          ||                   ||.||.||.||.||.||.||.||.||.|| 
    150 ||sum_p1_p2                ||                   ||.||.||.||.||.||.||.||.||.|| 
    151 ||sum_Ap1_1_Ap2            ||                   ||.||.||.||.||.||.||.||.||.|| 
    152 ||polynomial5              ||                   ||.||.||.||.||.||.||.||.||.|| 
    153 ||sph_bessel_jn            ||                   ||.||.||.||.||.||.||.||.||.|| 
    154 ||testmodel                ||                   ||.||.||.||.||.||.||.||.||.|| 
    155 ||testmodel_2              ||                   ||.||.||.||.||.||.||.||.||.|| 
     72||=!SasView name=||=sasmodels name=||= short_desc =||= param_table =||= long_desc =||= definition =||= formula =||= param_desc =||= plot =||= ref =||= attribution =||=Assigned=|| 
     73||HayterMSAStructure       ||hayter_msa         ||.||.||.||.||.||.||.||.||.||.|| 
     74||!BarBellModel            ||barbell            ||.||.||.||.||.||.||.||.||.||.|| 
     75||BCCrystalModel           ||bcc                ||.||.||.||.||.||.||.||.||.||.|| 
     76||BEPolyelectrolyte        ||be_polyelectrolyte ||.||.||.||.||.||.||.||.||.||.|| 
     77||!BroadPeakModel          ||broad_peak         ||.||.||.||.||.||.||.||.||.||.|| 
     78||!CappedCylinderModel     ||capped_cylinder    ||.||.||.||.||.||.||.||.||.||.|| 
     79||!CoreShellBicelleModel   ||core_shell_bicelle ||.||.||.||.||.||.||.||.||.||.|| 
     80||!CoreShellCylinderModel  ||core_shell_cylinder||.||.||.||.||.||.||.||.||.||.|| 
     81||!CoreShellEllipsoidModel||core_shell_ellipsoid||.||.||.||.||.||.||.||.||.||.|| 
     82||CoreShellEllipsoidXTModel||core_shell_ellipsoid_xt||.||.||.||.||.||.||.||.||.||.|| 
     83||!CoreShellModel          ||core_shell_sphere  ||.||.||.||.||.||.||.||.||.||.|| 
     84||!CorrLength              ||correlation_length ||.||.||.||.||.||.||.||.||.||.|| 
     85||CSParallelepipedModel    ||core_shell_parallelepiped||.||.||.||.||.||.||.||.||.||.|| 
     86||!CylinderModel           ||cylinder           ||.||.||.||.||.||.||.||.||.||.|| 
     87||DABModel                 ||dab                ||.||.||.||.||.||.||.||.||.||.|| 
     88||!EllipsoidModel          ||ellipsoid          ||.||.||.||.||.||.||.||.||.||.|| 
     89||!EllipticalCylinderModel ||elliptical_cylinder||.||.||.||.||.||.||.||.||.||.|| 
     90||FCCrystalModel           ||fcc                ||.||.||.||.||.||.||.||.||.||.|| 
     91||!FlexibleCylinderModel   ||flexible_cylinder  ||.||.||.||.||.||.||.||.||.||.|| 
     92||FlexCylEllipXModel      ||flexible_cylinder_ex||.||.||.||.||.||.||.||.||.||.|| 
     93||!FractalCoreShell        ||fractal_core_shell ||.||.||.||.||.||.||.||.||.||.|| 
     94||!FuzzySphereModel        ||fuzzy_sphere       ||.||.||.||.||.||.||.||.||.||.|| 
     95||!PeakGaussModel          ||gaussian_peak      ||.||.||.||.||.||.||.||.||.||.|| 
     96||!GaussLorentzGel         ||gauss_lorentz_gel  ||.||.||.||.||.||.||.||.||.||.|| 
     97||!GelFitModel             ||gel_fit            ||.||.||.||.||.||.||.||.||.||.|| 
     98||Guinier                  ||guinier            ||.||.||.||.||.||.||.||.||.||.|| 
     99||!GuinierPorod            ||guinier_porod      ||.||.||.||.||.||.||.||.||.||.|| 
     100||!HardsphereStructure     ||hardsphere         ||.||.||.||.||.||.||.||.||.||.|| 
     101||!HollowCylinderModel     ||hollow_cylinder    ||.||.||.||.||.||.||.||.||.||.|| 
     102||!LamellarModel           ||lamellar           ||.||.||.||.||.||.||.||.||.||.|| 
     103||LamellarPSModel          ||lamellarCaille     ||.||.||.||.||.||.||.||.||.||.|| 
     104||LamellarPSHGModel        ||lamellarCailleHG   ||.||.||.||.||.||.||.||.||.||.|| 
     105||LamellarFFHGModel        ||lamellarFFHG       ||.||.||.||.||.||.||.||.||.||.|| 
     106||LamellarPCrystallModel   ||lamellarPC         ||.||.||.||.||.||.||.||.||.||.|| 
     107||!LineModel               ||line               ||.||.||.||.||.||.||.||.||.||.|| 
     108||!LinearPearlsModel       ||linear_pearls      ||.||.||.||.||.||.||.||.||.||.|| 
     109||Lorentz                  ||lorentz            ||.||.||.||.||.||.||.||.||.||.|| 
     110||!MassFractalModel        ||mass_fractal       ||.||.||.||.||.||.||.||.||.||.|| 
     111||!MassSurfaceFractal     ||mass_surface_fractal||.||.||.||.||.||.||.||.||.||.|| 
     112||!MicelleSphCore          ||micelle_sphere_core||.||.||.||.||.|| ||.||.||.||.|| 
     113||!MultiShellModel         ||multi_shell        ||.||.||.||.||.||.||.||.||.||.|| 
     114||!ParallelepipedModel     ||parallelepiped     ||.||.||.||.||.||.||.||.||.||.|| 
     115||!PeakLorentzModel        ||peak_lorentz       ||.||.||.||.||.||.||.||.||.||.|| 
     116||!PearlNecklaceModel      ||pearl_necklace     ||.||.||.||.||.||.||.||.||.||.|| 
     117||!PolyExclVolume          ||polymer_excl_volume||.||.||.||.||.||.||.||.||.||.|| 
     118||!PorodModel              ||porod              ||.||.||.||.||.||.||.||.||.||.|| 
     119||!AbsolutePower_Law       ||power_law          ||.||.||.||.||.||.||.||.||.||.|| 
     120||!RectangularPrismModel   ||rectangular_prism  ||.||.||.||.||.||.||.||.||.||.|| 
     121||!RectangularHollowPrismModel||hollow_rectangular_prism||.||.||.||.||.||.||.||.||.||.|| 
     122||!RectangularHollowPrismInfThinWallsModel||hollow_rectangular_prism_infinitely_thin_walls ||.||.||.||.||.||.||.||.||.||.|| 
     123||SCCrystalModel           ||sc_crystal         ||.||.||.||.||.||.||.||.||.||.|| 
     124||!SphereModel             ||sphere             ||.||.||.||.||.||.||.||.||.||.|| 
     125||!StackedDisksModel       ||stacked_disk       ||.||.||.||.||.||.||.||.||.||.|| 
     126||!StarPolymer             ||star_polymer       ||.||.||.||.||.||.||.||.||.||.|| 
     127||StickyHSStructure        ||stickyhardsphere   ||.||.||.||.||.||.||.||.||.||.|| 
     128||!SurfaceFractalModel     ||surface_fractal    ||.||.||.||.||.||.||.||.||.||.|| 
     129||!TeubnerStrey            ||teubner_strey      ||.||.||.||.||.||.||.||.||.||.|| 
     130||!TriaxialEllipsoidModel  ||triaxial_ellipsoid ||.||.||.||.||.||.||.||.||.||.|| 
     131||!TwoLorentzian           ||two_lorentzian     ||.||.||.||.||.||.||.||.||.||.|| 
     132||!TwoPowerLaw             ||two_power_law      ||.||.||.||.||.||.||.||.||.||.|| 
     133||!VesicleModel            ||vesicle            ||.||.||.||.||.||.||.||.||.||.|| 
     134||BinaryHSModel            ||binary_hard_sphere ||.||.||.||.||.||.||.||.||.||.|| 
     135||Core2ndMomentModel       ||adsorbed_layer     ||.||.||.||.||.||.||.||.||.||.|| 
     136||!CoreMultiShellModel     ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     137||Debye                    ||mono_gauss_coil    ||.||.||.||.||.||.||.||.||.||.|| 
     138||!FractalModel            ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     139||!MultiplicationModel     ||                   ||.||.||.||.||.|| ||.||.||.||.|| 
     140||!OnionExpShellModel      ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     141||Poly_GaussCoil           ||poly_gauss_coil    ||.||.||.||.||.||.||.||.||.||.|| 
     142||!PringleModel            ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     143||!RaspBerryModel          ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     144||!ReflectivityModel       ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     145||ReflectivityIIModel      ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     146||RPA10Model               ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     147||SphericalSLDModel        ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     148||!SquareWellStructure     ||squarewell         ||.||.||.||.||.||.||.||.||.||.|| 
     149||!UnifiedPowerRg          ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     150||sum_p1_p2                ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     151||sum_Ap1_1_Ap2            ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     152||polynomial5              ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     153||sph_bessel_jn            ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     154||testmodel                ||                   ||.||.||.||.||.||.||.||.||.||.|| 
     155||testmodel_2              ||                   ||.||.||.||.||.||.||.||.||.||.||