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

Test new cookiecutter #66

Merged
merged 7 commits into from
Jul 21, 2023
Merged

Test new cookiecutter #66

merged 7 commits into from
Jul 21, 2023

Conversation

lauraporta
Copy link
Member

Description

Add new changes introduced in the cookie-cutter. Created via cruft.

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed? / What does this PR do?
Introduce the new hook for check-manifest in the pre-commit.
Cookie-cutter PR #65

Docs have been added as well

How has this PR been tested?

Tested locally, actions running on GitHub.

Here the output of pre-commit run --all-files

check docstring is first.................................................Passed
check that executables have shebangs.................(no files to check)Skipped
check for merge conflicts................................................Passed
check toml...............................................................Passed
fix end of files.........................................................Passed
mixed line ending........................................................Passed
fix requirements.txt.....................................................Passed
trim trailing whitespace.................................................Passed
ruff.....................................................................Passed
black....................................................................Passed
mypy.....................................................................Passed
check-manifest...........................................................Passed

Is this a breaking change?

No

Does this PR require an update to the documentation?

No

Checklist:

  • The code has been tested locally
  • Tests have been added to cover all new functionality
  • The documentation has been updated to reflect any changes
  • The code has been formatted with pre-commit

@lauraporta lauraporta requested a review from niksirbi June 30, 2023 15:13
@niksirbi
Copy link
Member

@lauraporta you have to modify docs/source/api_index.rst, because it's now trying to create API docs for nonexistent modules. You can also get rid of it completely and delete it from the TOC.
If you want the docs page to build, you'll also have to enable GH pages in this repo's settings

@lauraporta lauraporta marked this pull request as ready for review July 3, 2023 12:47
@codecov
Copy link

codecov bot commented Jul 3, 2023

Codecov Report

❗ No coverage uploaded for pull request base (main@5728e8f). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #66   +/-   ##
=======================================
  Coverage        ?   74.14%           
=======================================
  Files           ?       12           
  Lines           ?      642           
  Branches        ?        0           
=======================================
  Hits            ?      476           
  Misses          ?      166           
  Partials        ?        0           

@niksirbi
Copy link
Member

Looks good to me now.

@niksirbi niksirbi merged commit 77eb7c2 into main Jul 21, 2023
20 checks passed
@lauraporta lauraporta deleted the test-new-cookiecutter branch July 21, 2023 12:42
@lauraporta lauraporta mentioned this pull request Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants