Skip to content

Documentation and badge update#18

Merged
aburrell merged 4 commits intodevelopfrom
doc_badge_update
Mar 16, 2026
Merged

Documentation and badge update#18
aburrell merged 4 commits intodevelopfrom
doc_badge_update

Conversation

@aburrell
Copy link
Owner

@aburrell aburrell commented Mar 16, 2026

Description

Fixes #2 and #8, as well as adding the journal article reference to the docs.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • This change requires a documentation update

How Has This Been Tested?

Click on the new links.

Test Configuration

  • Operating system: OS X Tahoe
  • Version number: Python 3.10
  • Any details about your local setup that are relevant: N/A

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My commits are formatted appropriately (following the SciPy/NumPy style)
  • 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.md, summarising the changes
  • Add yourself to .zenodo.json

Added a missing colon to the bug issue template.
Updated the citations in the documentation.
Added the DOI and PyPi badges to the README.
Updated the changelog for this pull request.
@aburrell aburrell added this to the v0.1.1 milestone Mar 16, 2026
This was linked to issues Mar 16, 2026
@aburrell aburrell merged commit 0015d52 into develop Mar 16, 2026
50 of 52 checks passed
@aburrell aburrell deleted the doc_badge_update branch March 16, 2026 14:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

BUG: bug report templage ENH: Update missing badges

1 participant