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

Updated CLI instructions #146

Merged
merged 3 commits into from
Dec 30, 2024
Merged

Updated CLI instructions #146

merged 3 commits into from
Dec 30, 2024

Conversation

aburrell
Copy link
Owner

Description

Fixes #141 by updating the documentation. Also points users to Issue #113, which would fix the issue more cleanly.

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

python -m apexpy -h

Test Configuration

  • Operating system: OS X Ventura
  • Python version number: (e.g., 3.10)
  • Compiler with version number: (e.g. gfortran 14.2)
  • Relevant local setup details: this branch

Checklist

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to Changelog.rst, summarising the changes
  • Add yourself to AUTHORS.rst and .zenodo.json

Updated the command line interface instructions to include the `python -m` preface.
Updated changelog to include documentation update.
@aburrell aburrell added this to the 2.1.0 milestone Dec 23, 2024
@aburrell aburrell linked an issue Dec 23, 2024 that may be closed by this pull request
@aburrell aburrell requested a review from ljlamarche December 23, 2024 22:50
@aburrell aburrell added the documentation Documentation changes label Dec 23, 2024
@coveralls
Copy link

coveralls commented Dec 23, 2024

Pull Request Test Coverage Report for Build 12551124226

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 99.695%

Totals Coverage Status
Change from base Build 12551119687: 0.0%
Covered Lines: 981
Relevant Lines: 984

💛 - Coveralls

@aburrell aburrell merged commit 87146c8 into develop Dec 30, 2024
48 checks passed
@aburrell aburrell deleted the command_line_instructions branch December 30, 2024 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

BUG: command line usage has changed
2 participants