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

Update development setup documentation #3074

Merged
merged 1 commit into from
Nov 22, 2023
Merged

Conversation

zaneselvans
Copy link
Member

@zaneselvans zaneselvans commented Nov 21, 2023

PR Overview

  • Replace black autoformatting instructions with ruff
  • Include a note that you need to run git config to get nice conda lockfile merges.
  • Make PUDL conda environment setup instructions less confusing.

PR Checklist

  • Merge the most recent version of the branch you are merging into (probably dev).
  • All CI checks are passing. Run tests locally to debug failures
  • Make sure you've included good docstrings.
  • For major data coverage & analysis changes, run data validation tests
  • Include unit tests for new functions and classes.
  • Defensive data quality/sanity checks in analyses & data processing functions.
  • Update the release notes and reference reference the PR and related issues.
  • Do your own explanatory review of the PR to help the reviewer understand what's going on and identify issues preemptively.

@zaneselvans zaneselvans added the docs Documentation for users and contributors. label Nov 21, 2023
@zaneselvans zaneselvans self-assigned this Nov 21, 2023
docs/conf.py Show resolved Hide resolved
Comment on lines -86 to -89
$ mamba activate base
$ conda-lock install --name pudl-dev --mamba --dev environments/conda-lock.yml
$ mamba deactivate
$ mamba activate pudl-dev
Copy link
Member Author

Choose a reason for hiding this comment

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

I removed these details entirely, and defaulted to the instructions which use make. If folks want to see the detailed commands, they are listed in the Makefile

Copy link
Member

Choose a reason for hiding this comment

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

i think that's great

Comment on lines +204 to +206
* We also use `ruff to format our code <https://docs.astral.sh/ruff/formatter/>`__. It
serves as a much faster drop-in replacement for longtime crowd favorite `black
<https://black.readthedocs.io/en/stable/>`__
Copy link
Member Author

Choose a reason for hiding this comment

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

Swapped in ruff for black in the setup instructions.

Copy link

codecov bot commented Nov 22, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (fdd444d) 88.7% compared to head (4e0c235) 88.7%.
Report is 18 commits behind head on dev.

Files Patch % Lines
src/pudl/io_managers.py 81.8% 2 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##             dev   #3074   +/-   ##
=====================================
  Coverage   88.7%   88.7%           
=====================================
  Files         90      90           
  Lines      10994   10995    +1     
=====================================
+ Hits        9758    9759    +1     
  Misses      1236    1236           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zaneselvans zaneselvans merged commit f2d9fea into dev Nov 22, 2023
10 checks passed
@zaneselvans zaneselvans deleted the make-black-docs-update branch November 22, 2023 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation for users and contributors.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants