Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move config documentation into docstrings #916

Open
boolean5 opened this issue May 4, 2021 · 2 comments
Open

Move config documentation into docstrings #916

boolean5 opened this issue May 4, 2021 · 2 comments
Assignees
Labels
documentation task Doesn't change any behaviour

Comments

@boolean5
Copy link
Contributor

boolean5 commented May 4, 2021

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.

@boolean5 boolean5 added documentation task Doesn't change any behaviour labels May 4, 2021
@Ayushsunny
Copy link
Contributor

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

@vringar
Copy link
Contributor

vringar commented May 7, 2021

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"""
  1. 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.

This was referenced May 7, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation task Doesn't change any behaviour
Projects
None yet
Development

No branches or pull requests

3 participants