Skip to content

documentation #1

@orbeckst

Description

@orbeckst

The BornProfiler documentation currently consists mostly of the doc strings or placeholders.

  • Examples and use of the scripts: how should the typical user make use of the package?
    • describe workflow and individual steps
    • add figures that show typical output
  • More prose is needed to explain use of the classes for developers.
  • No "next" and "previous" links that allow one to quickly click through.
  • Customize the theme.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions