search

openwpm / OpenWPM

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

Move config documentation into docstrings #916

Open boolean5 opened 3 years ago

boolean5 commented 3 years ago

We could port some of our configuration documentation from Configuration.md to docstrings in config.py.

An idea would be to keep some parts of Configuration.md, such as the introductory part and the Browser profile support section, and point to the documentation that's autogenerated from the docstrings where needed.

Ayushsunny commented 3 years ago

Hello @boolean5 I would like to work on this issue. can you guide me for this?

vringar commented 3 years ago

Hey, to resolve this issue I'd like you to do the following things:

  1. Move the documentation from Configuration.md into the respective docstring of the attributes here E.g. for data_directory currently in Configuration.md it says "The directory into which screenshots and page dumps will be saved" so you'd write under https://github.com/mozilla/OpenWPM/blob/889b54d4295e1ad5c0da24c29a3b0ed746da33ba/openwpm/config.py#L119-L122

    """The directory into which screenshots and page dumps will be saved"""

  2. Figure if it's possible to link from the Configuration.md to the generated class documentation and if it isn't convert Configuration.md into Configuration.rst at which point you should be able to link to the generated class documentation.