Lightning-AI/pytorch-lightning

Update the docformatter pre-commit action

Open

#16,257 opened on Jan 4, 2023

View on GitHub
 (6 comments) (0 reactions) (1 assignee)Python (3,233 forks)batch import
cigood first issue

Repository metrics

Stars
 (26,687 stars)
PR merge metrics
 (Avg merge 9d 15h) (3 merged PRs in 30d)

Description

Outline & Motivation

docformatter v1.5.1 was released but we are still using v1.4 after we saw issues.

github.com/PyCQA/docformatter: v1.4 → v1.5.1

Pitch

Update this line: https://github.com/Lightning-AI/lightning/blob/3326e65bb2f7de2040bdf300dca062c627cdddb1/.pre-commit-config.yaml#L59

To v1.5.1

Then resolve the failures caused by the update.

Additional context

Already attempted in https://github.com/Lightning-AI/lightning/pull/16224 and #15344

cc @borda @carmocca @akihironitta

Contributor guide

Research direction
Update the docformatter version in .pre commit config.yaml from v1.4 to v1.5.1, then run pre commit run all files to see failures. Examine the failures (likely formatting changes) and resolve them by reformatting or adjusting configurations. Refer to previous attempts #16224 and #15344 for guidance.
Tech stack
python
Domain
devopstooling
Issue type
Chore
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitpre commitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60