Rietveld Code Review Tool
Help | Bug tracker | Discussion group | Source code

Side by Side Diff: README.md

Issue 29851654: Issue 6850 - Remove generation of checksums (Closed) Base URL: https://hg.adblockplus.org/python-abp/
Patch Set: Remove checksum documentation from the README Created Aug. 9, 2018, 10:05 p.m.
Left:
Right:
Use n/p to move between diff chunks; N/P to move between comments.
Jump to:
View unified diff | Download patch
« no previous file with comments | « no previous file | abp/filters/parser.py » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 10 matching lines...) Expand all
21 21
22 The filter lists are originally authored in relatively smaller parts focused 22 The filter lists are originally authored in relatively smaller parts focused
23 on a particular type of filters, related to a specific topic or relevant 23 on a particular type of filters, related to a specific topic or relevant
24 for particular geographical area. 24 for particular geographical area.
25 We call these parts _filter list fragments_ (or just _fragments_) 25 We call these parts _filter list fragments_ (or just _fragments_)
26 to distinguish them from full filter lists that are 26 to distinguish them from full filter lists that are
27 consumed by the adblocking software such as Adblock Plus. 27 consumed by the adblocking software such as Adblock Plus.
28 28
29 Rendering is a process that combines filter list fragments into a filter list. 29 Rendering is a process that combines filter list fragments into a filter list.
30 It starts with one fragment that can include other ones and so forth. 30 It starts with one fragment that can include other ones and so forth.
31 The produced filter list is marked with a version, a timestamp and 31 The produced filter list is marked with a version and a timestamp.
32 a [checksum][1].
Sebastian Noack 2018/08/09 22:37:03 Now we have an unreferenced URL at the bottom.
33 32
34 Python-abp contains a script that can do this called `flrender`: 33 Python-abp contains a script that can do this called `flrender`:
35 34
36 $ flrender fragment.txt filterlist.txt 35 $ flrender fragment.txt filterlist.txt
37 36
38 This will take the top level fragment in `fragment.txt`, render it and save into 37 This will take the top level fragment in `fragment.txt`, render it and save into
39 `filterlist.txt`. 38 `filterlist.txt`.
40 39
41 The `flrender` script can also be used by only specifying `fragment.txt`: 40 The `flrender` script can also be used by only specifying `fragment.txt`:
42 41
(...skipping 114 matching lines...) Expand 10 before | Expand all | Expand 10 after
157 156
158 All public functions, classes and methods should have docstrings compliant with 157 All public functions, classes and methods should have docstrings compliant with
159 [NumPy/SciPy documentation guide][5]. One exception is the constructors of 158 [NumPy/SciPy documentation guide][5]. One exception is the constructors of
160 classes that the user is not expected to instantiate (such as exceptions). 159 classes that the user is not expected to instantiate (such as exceptions).
161 160
162 [1]: https://adblockplus.org/filters#special-comments 161 [1]: https://adblockplus.org/filters#special-comments
163 [2]: https://adblockplus.org/filters#options 162 [2]: https://adblockplus.org/filters#options
164 [3]: http://pytest.org/ 163 [3]: http://pytest.org/
165 [4]: https://tox.readthedocs.org/ 164 [4]: https://tox.readthedocs.org/
166 [5]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt 165 [5]: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
OLDNEW
« no previous file with comments | « no previous file | abp/filters/parser.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld