chore(docs): add comments to API type in README#261
Conversation
This commit fills out the API types in the README with the comments that are present in `types.d.ts`, to add more context for every option.
|
Question before I do a full review: are the changes to types.d.ts pure reordering of items, or did you also change anything else? |
|
Ah so there were changes -- the |
tschneidereit
left a comment
There was a problem hiding this comment.
As always, I'd prefer for pure code motion to be split into separate commits. I haven't read these changes in thorough detail, because as-is that'd be a whole bunch of work. But given that this is just changing documentation, that's not the end of the world.
It's somewhat unfortunate that this introduces a complete, manual duplicate of the documentation, which is highly likely to get out of date quickly. I'm not entirely sure what to do about that, though: all the places where I could see us adding a "update this other place if you update this" note would be pretty unlikely to be noticed when actually doing updates.
Yeah I don't disagree... Maybe that API section should be removed and we should point to some real docs or just the TS file itself? I would argue that it is useful to have the API in the README. Kind of an annoying thing, wish there were ecosystem-standard generated docs to use (that everyone was aligned on) -- maybe I just haven't seen it yet in the JS space. |
This commit fills out the API types in the README with the comments that are present in
types.d.ts, to add more context for every option.Resolves #101