Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add inherited members to dict-like classes. #398

Merged
merged 1 commit into from
Oct 27, 2020
Merged

Conversation

bdice
Copy link
Member

@bdice bdice commented Oct 26, 2020

Description

Documents dict-like methods on JSONDict, H5Store, and inherited methods for H5StoreManager.

Motivation and Context

After discussion with @DomFijan, we decided we should document dict-like methods on JSONDict and related classes.

Types of Changes

  • Documentation update

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
  • I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable). See example below.

@bdice bdice requested review from a team as code owners October 26, 2020 16:36
@bdice bdice requested review from kidrahahjo, Tobias-Dwyer, atravitz and DomFijan and removed request for a team, kidrahahjo and Tobias-Dwyer October 26, 2020 16:36
Copy link

@Tobias-Dwyer Tobias-Dwyer left a comment

Choose a reason for hiding this comment

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

Looks about right.

@codecov
Copy link

codecov bot commented Oct 26, 2020

Codecov Report

Merging #398 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #398   +/-   ##
=======================================
  Coverage   76.40%   76.40%           
=======================================
  Files          45       45           
  Lines        7136     7136           
=======================================
  Hits         5452     5452           
  Misses       1684     1684           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d639e68...9d1d551. Read the comment docs.

@bdice bdice closed this Oct 26, 2020
@bdice bdice reopened this Oct 26, 2020
@bdice
Copy link
Member Author

bdice commented Oct 26, 2020

New feature: all pull requests (including this one) will have ReadTheDocs builds. Click "Show all checks" and look at ReadTheDocs to get a link to this PR's built docs. 😄

@bdice
Copy link
Member Author

bdice commented Oct 26, 2020

@atravitz @DomFijan Feel free to merge this after you review.

@bdice bdice merged commit 0f31ffc into master Oct 27, 2020
@bdice bdice deleted the doc/inherited-docstrings branch October 27, 2020 13:35
@bdice bdice added this to the v1.5.1 milestone Dec 19, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants