astrowidgets icon indicating copy to clipboard operation
astrowidgets copied to clipboard

Published 20 hours ago • verified publisher icon astropy

Do not merge: Plain text description of the API

Open mwcraig opened this issue 4 years ago • 3 comments

The intent of this is not to be merged. The intent was to do two things:

  • Pull in some of the very recent API changes or proposals (#145 and #140) into the rest of the API description.
  • Provide a (perhaps) easier format for discussing the API that is completely separate from implementation.

mwcraig avatar Jul 19 '21 16:07 mwcraig

But... but... our code is self-documenting...

pllim avatar Jul 19 '21 16:07 pllim

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 😬

mwcraig avatar Jul 19 '21 16:07 mwcraig

Both @gpdf and @astrofrog did not like my approach with #126 , so maybe #142 is the better way to go. 🤷

pllim avatar Jul 19 '21 16:07 pllim