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

docs: Use 'develop' extra over removed 'complete' #2113

Merged
merged 2 commits into from
Feb 14, 2023

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Feb 10, 2023

Description

Resolves #2110

  • Update all uses of the removed 'complete' extra to 'develop'.
    • The 'complete' extra was removed when moving to hatchling in PR build: Switch to using Hatchling as build backend #2095, but the 'develop' extra retains most of that functionality.
    • Update the 'complete' extra to 'all' for the Binder postBuild to reduce the number of dependencies that need to be installed.
  • Quote the extra for best practice to ensure compatibility across shells.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Update all uses of the removed 'complete' extra to 'develop'.
   - The 'complete' extra was removed when moving to hatchling in
     PR #2095, but the 'develop' extra retains most of that functionality.
   - Update the 'complete' extra to 'all' for the Binder postBuild to
     reduce the number of dependencies that need to be installed.
* Quote the extra for best practice to ensure compatibility across shells.

@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix labels Feb 10, 2023
@matthewfeickert matthewfeickert self-assigned this Feb 10, 2023
@matthewfeickert matthewfeickert added the Binder Contributing to having Binder build and Binder images run smoothly label Feb 10, 2023
@codecov
Copy link

codecov bot commented Feb 10, 2023

Codecov Report

Base: 98.30% // Head: 98.30% // No change to project coverage 👍

Coverage data is based on head (1842cab) compared to base (e80359f).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2113   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          69       69           
  Lines        4531     4531           
  Branches      645      645           
=======================================
  Hits         4454     4454           
  Misses         45       45           
  Partials       32       32           
Flag Coverage Δ
contrib 97.88% <ø> (ø)
doctest 61.15% <ø> (ø)
unittests-3.10 96.31% <ø> (ø)
unittests-3.8 96.33% <ø> (ø)
unittests-3.9 96.35% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

* The 'complete' extra was removed when moving to hatchling in PR 2095,
  but the 'develop' extra added most of that functionality.
@matthewfeickert matthewfeickert force-pushed the docs/remove-nonexistent-extras branch from feaaef0 to 1842cab Compare February 13, 2023 06:13
@matthewfeickert
Copy link
Member Author

I'm going to approve and merge this myself to keep things going. As always, PRs approved by a single core dev can be reverted as needed by the rest of the dev team.

@matthewfeickert matthewfeickert merged commit 6be19fb into main Feb 14, 2023
@matthewfeickert matthewfeickert deleted the docs/remove-nonexistent-extras branch February 14, 2023 16:29
matthewfeickert added a commit that referenced this pull request May 16, 2023
* Backport components of:
   - PR #2046
   - PR #2098
   - PR #2113
   - PR #2115
   - PR #2145
   - PR #2198
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Binder Contributing to having Binder build and Binder images run smoothly docs Documentation related fix A bug fix
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Setup extra "complete" no longer exists, but is mentioned in contribution docs
1 participant