Opened 3 years ago

Closed 2 years ago

#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):

https://codereview.adblockplus.org/29465720/

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.

Change History (4)

comment:1 Changed 3 years ago by kvas

  • Description modified (diff)
  • Owner set to kvas
  • Priority changed from Unknown to P3
  • Ready set

comment:2 Changed 2 years ago by kvas

  • Review URL(s) modified (diff)
  • Status changed from new to reviewing

comment:3 Changed 2 years ago by abpbot

A commit referencing this issue has landed:
Issue 4970 - Document the library API of python-abp

comment:4 Changed 2 years ago by kvas

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