Skip to content

Conversation

@zmoon
Copy link
Owner

@zmoon zmoon commented Jun 19, 2025

No description provided.

@codecov
Copy link

codecov bot commented Jun 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.02%. Comparing base (3a0b48c) to head (4305f22).
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
+ Coverage   89.50%   90.02%   +0.51%     
==========================================
  Files           9        9              
  Lines        1334     1333       -1     
==========================================
+ Hits         1194     1200       +6     
+ Misses        140      133       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

zmoon added 4 commits June 19, 2025 18:23
seems like only the first Tune instance gets rendered in the docs
rendering of the nb
which uses abcjs via IPython display
@zmoon zmoon marked this pull request as ready for review June 20, 2025 19:56
@zmoon zmoon requested a review from Copilot June 20, 2025 19:56
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR sets up the initial documentation infrastructure for PyABC2, enriches core classes with docstrings, adds example notebooks, and updates CI to build and test those docs.

  • Add doc extras to pyproject.toml and create Sphinx config (docs/conf.py, .readthedocs.yaml, docs/api.rst, docs/index.md).
  • Populate core modules (pitch.py, note.py, key.py, parse.py) with detailed docstrings.
  • Move example notebooks under docs/examples and update CI workflow to execute them.

Reviewed Changes

Copilot reviewed 15 out of 16 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
tests/test_note.py Extend parametric test for unimplemented methods
pyproject.toml Add doc dependency group
pyabc2/pitch.py Add missing docstrings for various methods
pyabc2/note.py Add docstrings and stubs for conversion methods
pyabc2/parse.py Add docstring for measures and repr, adjust HTML
pyabc2/key.py Enhance class and constructor docstrings
docs/conf.py Sphinx project configuration
docs/index.md Landing page for documentation
docs/api.rst Autosummary setup for API
docs/examples/* Initial example notebooks with headings
.readthedocs.yaml ReadTheDocs build configuration
.github/workflows/ci.yml Run notebooks from docs/examples
Comments suppressed due to low confidence (1)

pyabc2/note.py:288

  • This stub from_name definition overrides the actual implementation earlier in the class, breaking parsing functionality. Remove these duplicate stubs or rename them so you don't shadow the real constructors.
    def from_name(cls, *args, **kwargs):

@zmoon zmoon merged commit 826f077 into main Jun 20, 2025
7 checks passed
@zmoon zmoon deleted the docs branch June 20, 2025 20:01
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.

2 participants