Skip to content

Commit 5d11830

Browse files
committed
Add some new ADRs
1 parent e9d27f2 commit 5d11830

File tree

3 files changed

+64
-0
lines changed

3 files changed

+64
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 15. Use ruff
2+
3+
Date: 2024-02-15
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Ruff is faster than flake8 and black, has mostly compatible output, and is gaining popularity.
12+
13+
## Decision
14+
15+
We will switch to using ruff for linting and formatting.
16+
17+
## Consequences
18+
19+
We may have to consider pinning ruff in the future if its output changes regularly.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 16. Convert to mkdocs
2+
3+
Date: 2024-02-15
4+
5+
## Status
6+
7+
Rejected
8+
9+
## Context
10+
11+
Markdown is nicer to write, we have to write using mkdocs for the developer portal and backstage likes it, should we switch to using it?
12+
13+
It can mostly replace sphinx, but there are a few places it falls down:
14+
15+
- The API docs (mkdocstrings) have some paid for features that we already use in sphinx
16+
- The plugin landscape is vast, but not well maintained
17+
- The scientific python community (i.e. numpy, scipy, matplotlib, bluesky) uses sphinx exclusively
18+
- There are custom directives like the ipython one that we would struggle to replace
19+
20+
## Decision
21+
22+
We will stick with sphinx for now, but use MyST so we can write markdown with it.
23+
24+
## Consequences
25+
26+
We will keep an eye on mkdocs.
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# 17. Use pyright
2+
3+
Date: 2024-02-15
4+
5+
## Status
6+
7+
Accepted
8+
9+
## Context
10+
11+
Pyright is faster than mypy, and catches more errors.
12+
13+
## Decision
14+
15+
We will use it by default, but retain mypy as an option for existing projects where pyright gives too many errors to quickly migrate.
16+
17+
## Consequences
18+
19+
We will add a new question to let people switch between the two.

0 commit comments

Comments
 (0)