Skip to content

Instantly share code, notes, and snippets.

View brunobeltran's full-sized avatar

Bruno Beltran brunobeltran

View GitHub Profile
@brunobeltran
brunobeltran / gsod-final-report.md
Last active March 7, 2021 23:29
GSOD 2020 Final Report

Improving feature discoverability by centralizing documentation of “implicit” types

My proposal was centered around integrating the API documentation with a large swath of existing tutorials and examples by attempting to systematically document what I will call Matplotlib’s “implicit types”. These are a set of core concepts which, due to their “duck type”-heavy nature, have not yet merited their own proper class, but nonetheless are commonly accepted as inputs to a variety of Matplotlib routines internally, and whose documentation is currently scattered throughout docstrings, tutorials, and sometimes even just in examples.

The project led to multiple merged pull requests, and many technical challenges were overcome. Each “implicit” type that needed to be documented required the creation of a new bona-fide class, and this code had to retain backwards compatibility while adhering to the standards required for inclusion in the library. With the generous help of Hannah, Tim, and Tom, during we were able to h

@brunobeltran
brunobeltran / matplotlib-pr-state-machine.svg
Last active August 10, 2020 19:56
State Machine Describing the Matplotlib PR Process
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.