Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Sign in
  • swmfpy swmfpy
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar

Note: The default ITS GitLab runner is a shared resource and is subject to slowdowns during heavy usage.
You can run your own GitLab runner that is dedicated just to your group if you need to avoid processing delays.

  • SWMF_softwareSWMF_software
  • swmfpyswmfpy
  • Merge requests
  • !10

More tecplot documentation fixes

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Camilla Dodge Koslowsky Harris requested to merge cdha/swmfpy:more-tecplot-doc-fixes into master Sep 01, 2020
  • Overview 0
  • Commits 6
  • Pipelines 1
  • Changes 3

I noticed there were some issues with pydocs interpreting the docstrings on my functions so I've spent some time working on the documentation.

  • Added a script for generating the documentation on macos.
    • It's nearly identical but I guess either sed or the piping works a little differently.
  • Made the typing annotations more uniform.
  • I think this is a decent way to document keyword arguments:
    • Treat them like a regular argument but prefix the name with **, then explain more in an example.
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: more-tecplot-doc-fixes