Do not merge: Plain text description of the API #147
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is intended for making the discussion of the API separate from particular implementations of the API
mwcraig
added
API
|
But... but... our code is self-documenting... |
|
Agreed -- that is why this isn't intended to land in the repository ever. I thought it would be helpful to talk about any remaining API issues/questions before deciding how we move forward with that API (ABC or protocol or...). Put differently, I wasn't sure whether to update #126 or #142 so I copy-pasted into a separate doc 😬 |
|
Both @gpdf and @astrofrog did not like my approach with #126 , so maybe #142 is the better way to go. 🤷 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The intent of this is not to be merged. The intent was to do two things: