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

Update metadata docstrings #368

Merged
merged 32 commits into from
Nov 22, 2024
Merged

Update metadata docstrings #368

merged 32 commits into from
Nov 22, 2024

Conversation

sjvenditto
Copy link
Collaborator

@sjvenditto sjvenditto commented Nov 15, 2024

Summary

This PR updates the docstrings for new metadata functions, as well as docstrings for classes that inherit metadata.

  • all functions and properties in metadata_class.py, notably docstring examples added to set_info and get_info methods
  • interval_set.py > IntervalSet, time_series.py > TsdFrame, and ts_group.py > TsGroup: doc strings that were previously split under class definition and init have been merged, and new docstring examples added for initializing each class with and without metadata
  • docstrings were added to some properties throughout IntervalSet, TsGroup, TsdFrame, _BaseTsd, and _Base
  • "Metadata" section on the "User Guide > Core methods" documentation page has been updated

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines Coverage Δ
pynapple/core/base_class.py 99.11% <100.00%> (+0.02%) ⬆️
pynapple/core/interval_set.py 93.62% <100.00%> (+0.30%) ⬆️
pynapple/core/metadata_class.py 81.65% <100.00%> (+1.85%) ⬆️
pynapple/core/time_series.py 89.47% <100.00%> (+0.17%) ⬆️
pynapple/core/ts_group.py 92.26% <100.00%> (+0.24%) ⬆️

🚨 Try these New Features:

@sjvenditto sjvenditto marked this pull request as ready for review November 19, 2024 16:52
@sjvenditto sjvenditto requested a review from gviejo as a code owner November 19, 2024 16:52
doc/user_guide/04_core_methods.md Outdated Show resolved Hide resolved
pynapple/core/metadata_class.py Outdated Show resolved Hide resolved
pynapple/core/ts_group.py Outdated Show resolved Hide resolved
@gviejo gviejo merged commit 4e4613b into dev Nov 22, 2024
15 checks passed
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