[Xapian-tickets] [Xapian] #547: Auto-testing for example code in documentation

Xapian nobody at xapian.org
Tue Oct 31 10:47:04 GMT 2017


#547: Auto-testing for example code in documentation
-------------------------+--------------------------
 Reporter:  olly         |             Owner:  olly
     Type:  enhancement  |            Status:  new
 Priority:  normal       |         Milestone:  1.4.x
Component:  Test Suite   |           Version:
 Severity:  normal       |        Resolution:
 Keywords:               |        Blocked By:
 Blocking:               |  Operating System:  All
-------------------------+--------------------------
Description changed by ankitadixit:

Old description:

> Where we have example code in documentation, we really want to be certain
> that it actually would compile (and do what it is meant to, assuming it's
> a large enough snippet for that to be meaningful).
>
> So it would be great if there was a framework to achieve that.
>
> (This is mostly Richard's idea from ticket #503).
>
> Milestone 1.2.x, since this requires no API changes.

New description:

 Where we have example code in documentation, we really want to be certain
 that it actually would compile (and do what it is meant to, assuming it's
 a large enough snippet for that to be meaningful).

 So it would be great if there was a framework to achieve that.

 (This is mostly Richard's idea from ticket #503).

 Milestone 1.2.x, since this requires no API changes.

 [https://www.paisa.co/ifsc/au-small-finance-bank-limited/]

--

--
Ticket URL: <https://trac.xapian.org/ticket/547#comment:4>
Xapian <https://xapian.org/>
Xapian



More information about the Xapian-tickets mailing list