Skip to content

Commit 2d6deef

Browse files
authored
Merge pull request #25 from timhoffm/api-leader
Rephrase the role of API Leader
2 parents 3367d48 + 8b02218 commit 2d6deef

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

deputy_project_leads.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,29 +20,29 @@ An individual may be the RM for more than one release series at the
2020
same time.
2121

2222

23-
## API Consistency Leader
23+
## API Leader
2424

25-
Matplotlib is constantly making small changes to its API: enhancements
26-
that add new features, bug fixes that unavoidably change behavior, and
27-
deprecation of inconsistent or undesired functionality. The API
28-
Consistency Leader (ACL) is responsible for making sure that these
29-
incremental changes to the library are done in a coherent and
30-
consistent manner.
25+
A good API is essential for usability and user satisfaction. We strive for an
26+
API that is intuitive, easy to use, consistent and stable. The API Leader (AL)
27+
is responsible for the overall evolution of the API. In particular they ensure
28+
that:
3129

32-
This include checking that:
33-
34-
- new functionality is not duplicating existing functionality
35-
- deprecations are justified and properly documented
36-
- new functionality does not "paint us into a corner" for future work
37-
- new functionality is implemented with an API that is consistent with
38-
the existing functions
30+
- additions are justified, i.e. they do not duplicate existing functionality
31+
and do not exceed the intended scope of the library
32+
- additions are consistent with the existing API
33+
- additions are designed to not cause any future liabilities, i.e. they do not
34+
unintendedly limit future extensions or expose internals
35+
- changes are carefully balanced between their benefit for future users and
36+
their impact on existing code
37+
- changes follow the deprecation policy so that they do not hit users
38+
unprepeared
3939

4040

4141
## Principal Engineer
4242

4343
Matplotlib relies on a wide and deep code base to implement its public
4444
API; the low-level details need to be correct to faithfully implement
45-
that API. In contrast to the API Consistency Leader, who is
45+
that API. In contrast to the API Leader, who is
4646
responsible for what the library does, the Principal Engineer is
4747
responsible for how. They are the point of contact for:
4848

people.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Thomas Caswell [@tacaswell](https://github.com/tacaswell)
99
These are the current deputy project leader positions:
1010

1111
- **Release Mangagers** : (3.3, 3.4, 3.5) : Elliott Sales de Andrade [@qulogic](https://github.com/qulogic)
12-
- **API Consistency Leader** : Tim Hoffmann [@timhoffm](https://github.com/timhoffm)
12+
- **API Leader** : Tim Hoffmann [@timhoffm](https://github.com/timhoffm)
1313
- **Principal Engineer**: Antony Lee [@anntzer](https://github.com/anntzer)
1414
- **Reference Documentation Leader** :
1515
- **Narrative Documentation Leader** :

requirements-doc.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# List required packages in this file, one per line.
22
mpl-sphinx-theme
33
myst-parser
4-
sphinx
4+
sphinx<5 # pinned because current pydata-sphinx-theme is incompatible
5+
pydata-sphinx-theme<0.9 # temporary workaround to make the docs build

0 commit comments

Comments
 (0)