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.

Sign up for GitHub

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

Jump to bottom

Remove Project.index. #593

Merged
merged 4 commits into from
Aug 6, 2021
Merged

Remove Project.index. #593

merged 4 commits into from
Aug 6, 2021

Conversation

bdice
Copy link
Member

@bdice bdice commented Aug 6, 2021

Description

This PR makes the Project._index method private, removes all of its arguments aside from those used internally.
This PR also removes the indexing.py module (which is now unused) and corresponding tests for that module.

See also #591, which deprecates this method in signac 1.x.

Motivation and Context

Resolves a piece of #588.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

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 August 6, 2021 04:49
@bdice bdice requested review from b-butler and andkerr August 6, 2021 04:49
@bdice bdice added this to the v2.0.0 milestone Aug 6, 2021
@bdice bdice added the requires-1.x-deprecation Changes for 2.0 that require a deprecation to be added in 1.x. label Aug 6, 2021
@bdice bdice self-assigned this Aug 6, 2021
@codecov
Copy link

codecov bot commented Aug 6, 2021 •
edited
Loading

Codecov Report

Merging #593 (75ed47e) into next (257c931) will increase coverage by 0.23%.
The diff coverage is 91.66%.

Impacted file tree graph

@@            Coverage Diff             @@
##             next     #593      +/-   ##
==========================================
+ Coverage   83.77%   84.00%   +0.23%     
==========================================
  Files          54       53       -1     
  Lines        5535     5327     -208     
  Branches     1021      980      -41     
==========================================
- Hits         4637     4475     -162     
+ Misses        668      635      -33     
+ Partials      230      217      -13
Impacted Files Coverage Δ
signac/__main__.py 75.17% <0.00%> (ø)
signac/contrib/utility.py 51.88% <ø> (+4.38%) ⬆️
signac/contrib/project.py 86.22% <100.00%> (+0.30%) ⬆️

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 257c931...75ed47e. Read the comment docs.

This was referenced Aug 6, 2021
Merged
Merged
b-butler
b-butler approved these changes Aug 6, 2021
View reviewed changes
Copy link
Member

@b-butler b-butler left a comment

Choose a reason for hiding this comment

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

👍

@bdice bdice merged commit 2eda6b9 into next Aug 6, 2021
@bdice bdice deleted the remove-project-index branch August 6, 2021 16:23
@atravitz atravitz mentioned this pull request Aug 9, 2021
Merged
12 tasks
vyasr pushed a commit that referenced this pull request Nov 9, 2021
@bdice @vyasr
Remove Project.index. (#593)
a19a843 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
bdice added a commit that referenced this pull request Dec 5, 2021
@bdice
Remove Project.index. (#593)
7aa49cb 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Dec 25, 2021
@bdice @vyasr
Remove Project.index. (#593)
db9dc2d 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Jan 4, 2022
@bdice @vyasr
Remove Project.index. (#593)
3515b9e 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Jan 27, 2022
@bdice @vyasr
Remove Project.index. (#593)
124ebd7 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Feb 4, 2022
@bdice @vyasr
Remove Project.index. (#593)
bf8109e 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Feb 21, 2022
@bdice @vyasr
Remove Project.index. (#593)
11752b2 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Feb 21, 2022
@bdice @vyasr
Remove Project.index. (#593)
14253d0 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Mar 14, 2022
@bdice @vyasr
Remove Project.index. (#593)
3531746 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Apr 19, 2022
@bdice @vyasr
Remove Project.index. (#593)
8d8affa 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Apr 21, 2022
@bdice @vyasr
Remove Project.index. (#593)
5a7b129 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request May 2, 2022
@bdice @vyasr
Remove Project.index. (#593)
27195cd 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
bdice added a commit that referenced this pull request Jun 14, 2022
@bdice
Remove Project.index. (#593)
5905d5b 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
bdice added a commit that referenced this pull request Aug 1, 2022
@bdice
Remove Project.index. (#593)
ca315f7 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
bdice added a commit that referenced this pull request Oct 7, 2022
@bdice
Remove Project.index. (#593)
558db6f 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
bdice added a commit that referenced this pull request Oct 27, 2022
@bdice
Remove Project.index. (#593)
fda836e 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
vyasr pushed a commit that referenced this pull request Oct 30, 2022
@bdice @vyasr
Remove Project.index. (#593)
8f3ef6a 
* Make Project._index method private, refactor to remove unused arguments.

* Remove xfailed crawler test (functionality no longer needed).

* Delete indexing module.

* Clean up references to index in docs.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@b-butler b-butler b-butler approved these changes

@csadorf csadorf csadorf approved these changes

@andkerr andkerr Awaiting requested review from andkerr

Assignees

@bdice bdice

Labels
requires-1.x-deprecation Changes for 2.0 that require a deprecation to be added in 1.x.
Projects
None yet
Milestone
v2.0.0
Development

Successfully merging this pull request may close these issues.
3 participants
@bdice @csadorf @b-butler