Opened on 03/08/2017 at 07:46:42 PM
Closed on 10/24/2017 at 04:19:49 PM
#4970 closed change (fixed)
Document the library API of python-abp
| Reported by: | kvas | Assignee: | kvas |
|---|---|---|---|
| Priority: | P3 | Milestone: | |
| Module: | Sitescripts | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Platform: | Unknown / Cross platform | |
| Ready: | yes | Confidential: | no |
| Tester: | Unknown | Verified working: | no |
| Review URL(s): | |||
Description (last modified by kvas)
Background
Currently only flrender script is documented in README.md file of python-abp repository. As the library part is starting to be used as well, it would be helpful to have documentation for it to simplify the life of the users and define what is and what isn't a supported part of the API.
What to change
- Decide which internal parts of python-abp should be usable as a library -- this will be the public library API.
- Make sure the API has adequate test coverage to make maintaining compatibility in the future easier.
- Add documentation for the public library API to README.md.
Attachments (0)
Change History (4)
comment:1 Changed on 03/21/2017 at 09:46:53 AM by kvas
- Description modified (diff)
- Owner set to kvas
- Priority changed from Unknown to P3
- Ready set
comment:2 Changed on 06/14/2017 at 05:47:46 PM by kvas
- Review URL(s) modified (diff)
- Status changed from new to reviewing
comment:3 Changed on 10/24/2017 at 04:18:44 PM by abpbot
comment:4 Changed on 10/24/2017 at 04:19:49 PM by kvas
- Resolution set to fixed
- Status changed from reviewing to closed
Note: See
TracTickets for help on using
tickets.
A commit referencing this issue has landed:
Issue 4970 - Document the library API of python-abp