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

Add .devcontainer + .vscode/extensions.json #452

Merged
merged 20 commits into from
Aug 29, 2024
Merged

Add .devcontainer + .vscode/extensions.json #452

merged 20 commits into from
Aug 29, 2024

Conversation

sverhoeven
Copy link
Member

@sverhoeven sverhoeven commented Aug 5, 2024

TODO

  • edit python file
    • ewatercycle env activated
    • navigation
    • ruff
    • mypy
  • in terminal
    • ewatercycle env activated
    • ruff
    • mypy
    • pytest
    • precommit
  • vscode recommended extensions

Refs #441

sverhoeven and others added 16 commits July 31, 2024 13:33
In the past the DefaultForcing.generate() and load() methods had docstrings that rendered the model_specific_options of some models.
Now those models are in their own repos, so no longer need it here.
As recommonmark is deprecated
myst-nb has myst-parser as deps, so any *.md will also be processed by myst
autodoc2 does not handle google style docstrings so we switch back to the original autoapi.
TODO

* [ ] edit python file
  * [ ] ewatercycle env activated
  * [ ] navigation
  * [ ] ruff
  * [ ] mypy
* [ ] in terminal
  * [ ] ewatercycle env activated
  * [ ] ruff
  * [ ] mypy
  * [ ] pytest

Refs #441
Use removeEnv to set path + set envs in dockerfile
@sverhoeven sverhoeven changed the title Add .devcontainer Add .devcontainer + .vscode/extensions.json Aug 6, 2024
@sverhoeven sverhoeven marked this pull request as ready for review August 6, 2024 08:27
Copy link

sonarcloud bot commented Aug 6, 2024

Base automatically changed from docs-refresh to main August 21, 2024 05:53
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.93%. Comparing base (ce0fd1e) to head (16a1501).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #452   +/-   ##
=======================================
  Coverage   78.93%   78.93%           
=======================================
  Files          28       28           
  Lines        1804     1804           
  Branches      216      216           
=======================================
  Hits         1424     1424           
  Misses        323      323           
  Partials       57       57           

@BSchilperoort BSchilperoort self-requested a review August 27, 2024 07:36
Copy link
Member

@BSchilperoort BSchilperoort left a comment

Choose a reason for hiding this comment

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

First I used the link on the badge, but that didn't work correctly yet (as it refers to the main branch).

Manually cloning the repo and checking out this branch worked:

  • dev container installed successfully
  • specified VS Code extensions were installed automatically
  • pytest ran sucessfully inside the dev container
  • cd docs; make html generated the docs no problem

Nice work! 😄

Can you add a short mention of this VS Code dev container setup in the CONTRIBUTING.md file? That would allow others to find it more easily.

@sverhoeven sverhoeven merged commit b8eb041 into main Aug 29, 2024
3 checks passed
@sverhoeven sverhoeven deleted the devcontainer branch August 29, 2024 08:33
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