openwpm / OpenWPM

A web privacy measurement framework
https://openwpm.readthedocs.io
Other
1.33k stars 313 forks source link

Clarify wording in docs/Configuration.md wrt collection_fingerprinting #1014

Open tim-stephenson opened 1 year ago

tim-stephenson commented 1 year ago

https://github.com/openwpm/OpenWPM/blob/abf10d745a42f6781a1b6116976a613900f73977/docs/Configuration.md?plain=1#L162-L174 The statement:

 - `collection_fingerprinting` is the default if `js_instrument` is `True`. 

Is false, as it is no longer the default. I found this a bit confusing while reading over the docs.

vringar commented 1 year ago

I can confirm that collection_fingerprinting is still the default. https://github.com/openwpm/OpenWPM/blob/abf10d745a42f6781a1b6116976a613900f73977/openwpm/config.py#L83-L85 But I get how the docs are confusing in this aspect.

vringar commented 1 year ago

The docs should be updated to state, that the js_instrument_settings, that were the default prior to v0.11.0 have been grouped into a collection called collection_fingerprinting and that this collection is the default configuration, when enabling the js_instrument.