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

Code & Doc clean-up #15

Merged
merged 4 commits into from Feb 5, 2019

Conversation

Projects
None yet
2 participants
@adam3smith
Copy link
Contributor

adam3smith commented Feb 3, 2019

  • use stop for API-key related errors
  • Some more function name alignments.
  • Clean up Readme
  • Remove license from documentation
  • Remove unused functions
@adam3smith

This comment has been minimized.

Copy link
Contributor

adam3smith commented Feb 3, 2019

@greebie -- would you have time to look over this to make sure there's nothing dumb and/or things you strongly disagree with. I tested on both Windows & Linux and working nicely.

@greebie
Copy link
Collaborator

greebie left a comment

Thanks so much for the clean up Sebastian. Just a few minor fixes and then we're good to merge.

Show resolved Hide resolved R/archivr.R Outdated
if ((!(is.null(reply$detail))) && reply$detail == "Authentication credentials were not provided.") {
stop("Please input your api key:\nUse 'set_api_key(API_KEY)'")
} else if ((!(is.null(reply$error)))) {
print(reply)

This comment has been minimized.

@greebie

greebie Feb 5, 2019

Collaborator

Probably worth removing this print statement (my bad).

This comment has been minimized.

@adam3smith

adam3smith Feb 5, 2019

Contributor

No, that actually printed on an error I got from perma.cc and was quite helpful.

This comment has been minimized.

@greebie

greebie Feb 5, 2019

Collaborator

Sounds good.

Show resolved Hide resolved R/archivr.R Outdated
arc_url_df <- archiv.fromText("path_to_file")
```

To allow for pre-processing of URLs before archiving, `archivr` also provides access to the funcitons used to extract URLs from a webpage (`extract_urls_from_webpage("URL")`), from a files (`extract_urls_from_text("filepath")`) (tested for .docx, markdown, and pdf), and from any supported text file in a folder (`extract_urls_from_folder("filepath")`)

This comment has been minimized.

@greebie

greebie Feb 5, 2019

Collaborator

typo "funcitons" should be "functions"

@adam3smith adam3smith merged commit 61462ca into master Feb 5, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment