Skip to content

Adding note to readme for how to do manual run#19

Merged
SuperKogito merged 2 commits intomasterfrom
add/readme-note-manual-run
Apr 4, 2020
Merged

Adding note to readme for how to do manual run#19
SuperKogito merged 2 commits intomasterfrom
add/readme-note-manual-run

Conversation

@vsoch
Copy link
Copy Markdown
Collaborator

@vsoch vsoch commented Mar 26, 2020

I ran into the issue of wanting to just check a list of urls, and not interact with the client. This is possible, and I think we should expose how to do this in the README (the purpose of this PR).

Don't worry about time to review this @SuperKogito - it's a tiny detail just in the docs!

Signed-off-by: vsoch vsochat@stanford.edu

In the case that someone just wants to check a list of URLs, this
should be shown in the README as a simple import of check_urls

Signed-off-by: vsoch <vsochat@stanford.edu>
@vsoch vsoch requested a review from SuperKogito March 26, 2020 18:28
@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 26, 2020

Codecov Report

Merging #19 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #19   +/-   ##
=======================================
  Coverage   73.14%   73.14%           
=======================================
  Files          15       15           
  Lines         499      499           
=======================================
  Hits          365      365           
  Misses        134      134           

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 f21f0c7...42d25e6. Read the comment docs.

Signed-off-by: vsoch <vsochat@stanford.edu>
@vsoch
Copy link
Copy Markdown
Collaborator Author

vsoch commented Mar 26, 2020

Also note that I accidentally added github.py (which shouldn't have been!) that has code that is ultimately represented in check.py. I can't believe we both missed this! Luckily it doesn't interact with any other code so it shouldn't be an issue for the previous releases. I still feel rather silly though :P

Copy link
Copy Markdown
Member

@SuperKogito SuperKogito left a comment

Choose a reason for hiding this comment

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

I think we agreed to delete urlchecker/client/github.py
The README changes look good to me. it is a nice example 👍
I will merge and test tonight ;) then we can release.

@SuperKogito SuperKogito merged commit 499e329 into master Apr 4, 2020
@vsoch vsoch deleted the add/readme-note-manual-run branch April 4, 2020 18:35
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