Changeset a26f67f in sasview


Ignore:
Timestamp:
Sep 28, 2017 6:17:46 PM (3 years ago)
Author:
Paul Kienzle <pkienzle@…>
Branches:
master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, magnetic_scatt, release-4.2.2, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload
Children:
3bd677b
Parents:
59dfb53
Message:

fixup api doc errors

Location:
src/sas
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • src/sas/sascalc/corfunc/corfunc_calculator.py

    rb916afa ra26f67f  
    177177        """ 
    178178        Extract the interesting measurements from a correlation function 
    179         :param transformed_data: Fourier transformation of the 
    180             extrapolated data 
     179 
     180        :param transformed_data: Fourier transformation of the extrapolated data 
    181181        """ 
    182182        # Calculate indexes of maxima and minima 
  • src/sas/sascalc/data_util/registry.py

    rdc8d1c2 ra26f67f  
    121121        Call the loader for the file type of path. 
    122122 
    123         :raise ValueError: if no loader is available. 
    124         :raise KeyError: if format is not available. 
     123        :raises ValueError: if no loader is available. 
     124        :raises KeyError: if format is not available. 
     125 
    125126        May raise a loader-defined exception if loader fails. 
    126127        """ 
  • src/sas/sascalc/file_converter/c_ext/__init__.py

    r18e7309 ra26f67f  
     1""" 
     2    Data loader for the Diamond BSL beamline. 
     3""" 
  • src/sas/sasgui/guiframe/CategoryInstaller.py

    rb963b20 ra26f67f  
    112112    def check_install(homedir = None, model_list=None): 
    113113        """ 
    114         the main method of this class 
    115         makes sure categories.json exists and if not 
    116         compile it and install 
     114        Makes sure categories.json exists and if not compile it and install. 
     115 
     116        This is the main method of this class. 
     117 
    117118        :param homefile: Override the default home directory 
    118         :param model_list: List of model names except those in Plugin Models 
    119               which are user supplied. 
     119        :param model_list: List of model names except those in 
     120            Plugin Models which are user supplied. 
    120121        """ 
    121122        _model_dict = {model.name: model for model in model_list} 
  • src/sas/sasgui/guiframe/local_perspectives/plotting/parameters_panel_slicer.py

    r47d93073 ra26f67f  
    395395        """ 
    396396        Event based parameter setting. 
     397 
    397398        :param evt: Event triggered to apply parameters to a list of plots 
    398                     evt should have attrs plot_list and params 
     399           evt should have attrs plot_list and params 
     400 
    399401        """ 
    400402        if evt is None: 
     
    467469        """ 
    468470        Send a list of data to the fitting perspective 
    469         :param fit: fit type desired  
     471        :param fit: fit type desired 
    470472        :param file_list: list of loaded file names to send to fit 
    471473        """ 
  • src/sas/sasgui/perspectives/file_converter/converter_panel.py

    r19296dc ra26f67f  
    9393        <SasData> element. 
    9494 
    95         :param frame_data: If single_file is true, an array of Data1D objects. 
    96         If single_file is false, a dictionary of the form frame_number: Data1D. 
     95        :param frame_data: If single_file is true, an array of Data1D 
     96            objects. If single_file is false, a dictionary of the 
     97            form *{frame_number: Data1D}*. 
    9798        :param filepath: Where to save the CanSAS file 
    98         :param single_file: If true, array is saved as a single file, if false, 
    99         each item in the array is saved to it's own file 
     99        :param single_file: If true, array is saved as a single file, 
     100            if false, each item in the array is saved to it's own file 
    100101        """ 
    101102        writer = CansasWriter() 
     
    192193        :return x_data: A 1D array containing all the x coordinates of the data 
    193194        :return y_data: A 1D array containing all the y coordinates of the data 
    194         :return frame_data: A dictionary of the form frame_number: data, where 
    195         data is a 2D numpy array containing the intensity data 
     195        :return frame_data: A dictionary of the form *{frame_number: data}*, where data is a 2D numpy array containing the intensity data 
    196196        """ 
    197197        loader = BSLLoader(filename) 
  • src/sas/sasgui/plottools/LineModel.py

    r959eb01 ra26f67f  
    22""" 
    33Provide Line function (y= Ax + B). Until July 10, 2016 this function provided 
    4 (y= A + Bx).  This however was contrary to all the other code using it which  
     4(y= A + Bx).  This however was contrary to all the other code using it which 
    55assumed (y= mx+b) or in this nomenclature (y=Ax + B). This lead to some 
    66contortions in the code and worse incorrect calculations until now for at least 
     
    6767        Evaluate the model 
    6868 
    69         :note: This is the function called by fitDialog to calculate the 
    70         the y(xmin) and y(xmax), but the only difference between this and 
    71         runXY is when the if statement is true. I however cannot see what that 
    72         function is for.  It needs to be documented here or removed. 
    73         PDB 7/10/16  
    74  
    7569        :param x: simple value 
    7670 
    7771        :return: (Line value) 
     72 
     73        .. note:: 
     74            This is the function called by fitDialog to calculate the 
     75            the y(xmin) and y(xmax), but the only difference between this and 
     76            runXY is when the if statement is true. I however cannot see what 
     77            that function is for.  It needs to be documented here or removed. 
     78            PDB 7/10/16 
    7879        """ 
    7980        if x.__class__.__name__ == 'list': 
     
    8990        """ 
    9091        Evaluate the model. 
    91          
    92         :note: This is to be what is called by fitDialog for the actual fit 
    93         but the only difference between this and run is when the if  
    94         statement is true. I however cannot see what that function 
    95         is for.  It needs to be documented here or removed. PDB 7/10/16  
    9692 
    9793        :param x: simple value 
     
    9995        :return: Line value 
    10096 
     97        .. note:: 
     98            This is to be what is called by fitDialog for the actual fit 
     99            the only difference between this and run is when the if 
     100            statement is true. I however cannot see what that function 
     101            is for.  It needs to be documented here or removed. PDB 7/10/16 
    101102        """ 
    102103        if x.__class__.__name__ == 'list': 
Note: See TracChangeset for help on using the changeset viewer.