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 #920

Merged
merged 1 commit into from
May 10, 2021
Merged

Conversation

Ayushsunny
Copy link
Contributor

Move config documentation into docstrings
issue code - #916

@Ayushsunny
Copy link
Contributor Author

Hello @vringar could you review this PR that I'm doing right or not? please

@vringar vringar self-requested a review May 10, 2021 08:10
Copy link
Contributor

@vringar vringar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @Ayushsunny,
sorry for taking a while to get back to you.
I left a comment showing how the docstring should be formatted.

openwpm/config.py Outdated Show resolved Hide resolved
@vringar
Copy link
Contributor

vringar commented May 10, 2021

As you can see all the tests are currently failing because the way you inserted the docstrings is invalid in python.

@codecov
Copy link

codecov bot commented May 10, 2021

Codecov Report

Merging #920 (51b22a6) into master (889b54d) will decrease coverage by 0.17%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #920      +/-   ##
==========================================
- Coverage   50.91%   50.73%   -0.18%     
==========================================
  Files          34       34              
  Lines        3390     3390              
==========================================
- Hits         1726     1720       -6     
- Misses       1664     1670       +6     
Impacted Files Coverage Δ
openwpm/config.py 95.83% <ø> (ø)
openwpm/utilities/multiprocess_utils.py 50.00% <0.00%> (-4.77%) ⬇️
openwpm/browser_manager.py 70.31% <0.00%> (-1.05%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 889b54d...51b22a6. Read the comment docs.

@Ayushsunny
Copy link
Contributor Author

As you can see all the tests are currently failing because the way you inserted the docstrings is invalid in python.

Hello Sir, I have amend the changes.
can you check now please

@vringar
Copy link
Contributor

vringar commented May 10, 2021

This looks really good, thank you!
Could you please also remove the lines from Configuration.md.

@Ayushsunny
Copy link
Contributor Author

This looks really good, thank you!
Could you please also remove the lines from Configuration.md.

@vringar Done

openwpm/config.py Outdated Show resolved Hide resolved
openwpm/config.py Outdated Show resolved Hide resolved
openwpm/config.py Outdated Show resolved Hide resolved
openwpm/config.py Outdated Show resolved Hide resolved
@Ayushsunny
Copy link
Contributor Author

Can you see now @vringar ?

openwpm/config.py Outdated Show resolved Hide resolved
@vringar
Copy link
Contributor

vringar commented May 10, 2021

This looks very good. Thank you!

@vringar vringar merged commit 7e126af into openwpm:master May 10, 2021
Zaxeli pushed a commit to Zaxeli/OpenWPM that referenced this pull request Aug 10, 2021
@Ayushsunny Ayushsunny deleted the mov branch August 26, 2021 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants