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 structure changes #7

Open
6 tasks done
sfarrens opened this issue Jul 20, 2022 · 0 comments
Open
6 tasks done

Documentation structure changes #7

sfarrens opened this issue Jul 20, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@sfarrens
Copy link
Contributor

sfarrens commented Jul 20, 2022

To better match the standards introduced in PySAP issue #179 I propose that the following changes be made to PySAP-ETomo.

in examples

  • Add a README.txt with the following content:
    .. _etomo_examples:
    
    ETomo Examples
    --------------
    
    Here we present a selection of examples using tools provided in the PySAP-ETomo plug-in.
    
  • Prefix all example file names with plot_, so that a thumbnail can be displayed.
  • For any images to be rendered (including the thumbnail) use Matplotlib instead of the PySAP built-in show method. Note that the thumbnail will be the first image rendered.
  • Use # %% to define new notebook cells.

in etomo

  • Update __init__.py as follows.
    """PYSAP-ETOMO.
    
    This plug-in provides tools for electron tomography data processing.
    
    """
  • Ensure that all parameters/returns data types are valid (where possible). (e.g. np.array -> numpy.ndarray)

Refer to PySAP-ASTRO for examples.

@sfarrens sfarrens added the documentation Improvements or additions to documentation label Jul 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants