README.md - Issue 29824555: Issue #4116: Make infile and outfile parameters of flrender script from python-abp optional

Delta Between Two Patch Sets: README.md

Issue 29824555: Issue #4116: Make infile and outfile parameters of flrender script from python-abp optional (Closed)

Left Patch Set: Created July 6, 2018, 11:39 a.m.

Right Patch Set: Removed unnecessary locals() call Created July 17, 2018, 9:39 a.m.

Left:
Right:

Use n/p to move between diff chunks; N/P to move between comments.

Jump to:

Left: Side by side diff | Download
Right: Side by side diff | Download

LEFT	RIGHT
1 # python-abp	1 # python-abp

2	2

3 This repository contains a library for working with Adblock Plus filter lists	3 This repository contains a library for working with Adblock Plus filter lists

4 and the script that is used for building Adblock Plus filter lists from the	4 and the script that is used for building Adblock Plus filter lists from the

5 form in which they are authored into the format suitable for consumption by the	5 form in which they are authored into the format suitable for consumption by the

6 adblocking software.	6 adblocking software.

7	7

8 ## Installation	8 ## Installation

9	9

10 Prerequisites:	10 Prerequisites:

(...skipping 24 matching lines...) Expand all Loading...
35	35

36 $ flrender fragment.txt filterlist.txt	36 $ flrender fragment.txt filterlist.txt

37	37

38 This will take the top level fragment in `fragment.txt`, render it and save into	38 This will take the top level fragment in `fragment.txt`, render it and save into

39 `filterlist.txt`.	39 `filterlist.txt`.

40	40

41 The `flrender` script can also be used by only specifying `fragment.txt`:	41 The `flrender` script can also be used by only specifying `fragment.txt`:

42	42

43 $flrender fragment.txt	43 $flrender fragment.txt

44	44

45 in which case the rendering result will be returned to `stdout`. Moreover, when	45 in which case the rendering result will be sent to `stdout`. Moreover, when
Vasily Kuznetsov 2018/07/09 17:00:57 "returned" feels a bit weird here. What do you thi "returned" feels a bit weird here. What do you think about "will be _sent_ to stdout"? Tudor Avram 2018/07/10 16:09:47 Done. Show quoted text On 2018/07/09 17:00:57, Vasily Kuznetsov wrote: > "returned" feels a bit weird here. What do you think about "will be _sent_ to > stdout"? Done.
46 being run with no positional arguments:	46 it's run with no positional arguments:
Vasily Kuznetsov 2018/07/09 17:00:57 Perhaps eliminate the passive here to make it easi Perhaps eliminate the passive here to make it easier to read? "Moreover, if you run `flrender` with no ..." Tudor Avram 2018/07/10 16:09:47 Done. Show quoted text On 2018/07/09 17:00:57, Vasily Kuznetsov wrote: > Perhaps eliminate the passive here to make it easier to read? "Moreover, if you > run `flrender` with no ..." Done.
47	47

48 $flrender	48 $flrender

49	49

50 it will read from `stdin` and output the results to `stdout`.	50 it will read from `stdin` and send the results to `stdout`.

51	51

52 Fragments might reference other fragments that should be included into them.	52 Fragments might reference other fragments that should be included into them.

53 The references come in two forms: http(s) includes and local includes:	53 The references come in two forms: http(s) includes and local includes:

54	54

55 %include http://www.server.org/dir/list.txt%	55 %include http://www.server.org/dir/list.txt%

56 %include easylist:easylist/easylist_general_block.txt%	56 %include easylist:easylist/easylist_general_block.txt%

57	57

58 The first instruction contains a URL that will be fetched and inserted at the	58 The first instruction contains a URL that will be fetched and inserted at the

59 point of reference.	59 point of reference.

60 The second one contains a path inside easylist repository.	60 The second one contains a path inside easylist repository.

(...skipping 96 matching lines...) Expand 10 before \| Expand all \| Expand 10 after Loading...
157	157

158 All public functions, classes and methods should have docstrings compliant with	158 All public functions, classes and methods should have docstrings compliant with

159 [NumPy/SciPy documentation guide][5]. One exception is the constructors of	159 [NumPy/SciPy documentation guide][5]. One exception is the constructors of

160 classes that the user is not expected to instantiate (such as exceptions).	160 classes that the user is not expected to instantiate (such as exceptions).

161	161

162 [1]: https://adblockplus.org/filters#special-comments	162 [1]: https://adblockplus.org/filters#special-comments

163 [2]: https://adblockplus.org/filters#options	163 [2]: https://adblockplus.org/filters#options

164 [3]: http://pytest.org/	164 [3]: http://pytest.org/

165 [4]: https://tox.readthedocs.org/	165 [4]: https://tox.readthedocs.org/

166 [5]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt	166 [5]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

LEFT	RIGHT