-
Notifications
You must be signed in to change notification settings - Fork 37
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
Remove public API of indexing module. #580
Merged
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
c524915
to
012118a
Compare
12 tasks
Codecov Report
@@ Coverage Diff @@
## next #580 +/- ##
==========================================
+ Coverage 82.41% 83.40% +0.98%
==========================================
Files 54 54
Lines 5845 5597 -248
Branches 1097 1033 -64
==========================================
- Hits 4817 4668 -149
+ Misses 785 696 -89
+ Partials 243 233 -10
Continue to review full report at Codecov.
|
5 tasks
mikemhenry
approved these changes
Aug 3, 2021
vyasr
pushed a commit
that referenced
this pull request
Nov 9, 2021
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
bdice
added a commit
that referenced
this pull request
Dec 5, 2021
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Dec 25, 2021
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Jan 4, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Jan 27, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Feb 4, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Feb 21, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Feb 21, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Mar 14, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Apr 19, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Apr 21, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
May 2, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
bdice
added a commit
that referenced
this pull request
Jun 14, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
bdice
added a commit
that referenced
this pull request
Aug 1, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
bdice
added a commit
that referenced
this pull request
Oct 7, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
bdice
added a commit
that referenced
this pull request
Oct 27, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
vyasr
pushed a commit
that referenced
this pull request
Oct 30, 2022
* Remove public API for indexing module. * Remove index command from signac.__main__. * Remove tests for methods and classes that have been removed. * Remove index from CLI help message. * Make indexing features adhere to pydocstyle. * Fix typo. * Remove index shell test.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR removes a large portion of the public API of the
indexing
module. It appears the only internal use of theindexing
APIs may be theSignacProjectCrawler
(now a private class) inProject.index()
. We may also choose to makeProject.index()
private, but I think I would wait for a subsequent PR instead of expanding the scope of this PR.This depends on #574 and #576.
To-do:
setup.cfg
to remove exclusions for pydocstyle and pytest deprecation warnings for theindexing
module.For tasks to be accomplished in subsequent PRs, see issue #588.
Motivation and Context
Part of signac 2.0 API cleanup.
Types of Changes
1The change breaks (or has the potential to break) existing functionality.
Checklist:
If necessary: