signac
signac copied to clipboard
Make synced collection a hidden package
Description
Make synced collection package hidden.
Motivation and Context
Resolves #790
Checklist:
- [x] I am familiar with the Contributing Guidelines.
- [x] I agree with the terms of the Contributor Agreement.
- [x] My name is on the list of contributors.
- [x] The changes introduced by this pull request are covered by existing or newly introduced tests.
- [ ] The package documentation and framework documentation in signac-docs are up to date with these changes.
- [x] I have updated the changelog and added any related issue and pull request numbers for future reference.
Codecov Report
Merging #807 (0279ce0) into next (52ff017) will decrease coverage by
1.31%
. The diff coverage is78.85%
.
@@ Coverage Diff @@
## next #807 +/- ##
==========================================
- Coverage 86.32% 85.00% -1.32%
==========================================
Files 51 54 +3
Lines 4687 4675 -12
Branches 1022 1011 -11
==========================================
- Hits 4046 3974 -72
- Misses 456 522 +66
+ Partials 185 179 -6
Impacted Files | Coverage Δ | |
---|---|---|
signac/_synced_collections/__init__.py | 100.00% <ø> (ø) |
|
signac/_synced_collections/_caching.py | 0.00% <0.00%> (ø) |
|
signac/_synced_collections/backends/__init__.py | 100.00% <ø> (ø) |
|
..._synced_collections/backends/collection_mongodb.py | 90.90% <ø> (ø) |
|
...c/_synced_collections/backends/collection_redis.py | 65.62% <ø> (ø) |
|
...ac/_synced_collections/backends/collection_zarr.py | 88.00% <ø> (ø) |
|
signac/_synced_collections/buffers/__init__.py | 100.00% <ø> (ø) |
|
..._collections/buffers/memory_buffered_collection.py | 100.00% <ø> (ø) |
|
signac/_synced_collections/data_types/__init__.py | 100.00% <ø> (ø) |
|
signac/_synced_collections/data_types/attr_dict.py | 100.00% <ø> (ø) |
|
... and 60 more |
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
@bdice @kidrahahjo I've standardized the docs in a relatively simple way. Let me know what you two think. In the interest of getting 2.0 done. I think we shouldn't belabor the documentation question too much further for now; we can revisit in 2.x, especially once synced_collections
is actually a separate, accessible package, but I don't want to block 2.0 over that discussion.