#3690 closed defect (wontfix)

Document new API

Reported by: maylee Owned by: maylee
Priority: normal Milestone: User Documentation Goals
Component: documentation Version: n/a
Keywords: Cc:
Launchpad Bug:

Description (last modified by maylee)

The documentation at /docs/frontends/webapi.rst needs to be deleted or rewritten after we replace the current API.

Change History (7)

comment:1 Changed at 2021-05-02T19:13:13Z by maylee

  • Owner set to maylee
  • Status changed from new to assigned

comment:2 Changed at 2021-05-02T23:32:38Z by exarkun

What problem would this rewrite address?

Also, the API it describes is bad and we should replace it with a new, different one.

comment:3 Changed at 2021-05-03T08:49:24Z by maylee

  • Description modified (diff)
  • Summary changed from Edit Web API documentation to Document new API

With that in mind, this rewrite can hold off until the API is replaced, and it would really be documentation for the new API. At any rate, whatever's at /docs/frontends/webapi.rst needs to be changed.

Ticket has been changed to reflect this perspective.

comment:4 Changed at 2021-05-03T11:07:14Z by exarkun

A better development workflow might be that every incremental implementation effort on the new API (which will certainly not be merged as a single, fully-formed thing) comes along with its own new chunk of documentation.

If so, the tickets we want are probably more like "New API for XXX" where "XXX" is stuff like "upload a file", "download a file", etc (these are examples; the new API hasn't been given much dedicated thought yet).

comment:5 Changed at 2021-05-04T18:12:12Z by maylee

Noted, can we keep this ticket in place until those API changes take place?

comment:6 Changed at 2021-05-11T15:19:12Z by exarkun

If it were just me, I'd close this. All documentation should be delivered alongside (and at the same time as) the implementation.

comment:7 Changed at 2021-05-11T15:25:47Z by maylee

  • Resolution set to wontfix
  • Status changed from assigned to closed
Note: See TracTickets for help on using tickets.