Skip to content

Commit

Permalink
Update | Updating Manual Links and GIFs
Browse files Browse the repository at this point in the history
Merge pull request #59 from JosephLai241/development
  • Loading branch information
JosephLai241 authored May 8, 2023
2 parents 74dd706 + 2ec17e2 commit 6fb11da
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 18 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,16 +137,16 @@ This is a shout-out section for my patrons - thank you so much for sponsoring th

<!--Manual links-->

[check praw rate limits manual link]: UPDATETHISLINKLATER/utilities/rate-limit-checking.html
[contributing manual link]: UPDATETHISLINKLATER/contributing/before-making-pull-or-feature-requests.html
[display directory tree manual link]: UPDATETHISLINKLATER/utilities/tree.html
[frequencies scraping manual link]: UPDATETHISLINKLATER/analytical-tools/frequencies-and-wordclouds.html#generating-word-frequencies
[livestream scraping manual link]: UPDATETHISLINKLATER/livestreaming-reddit/general-information.html
[redditor scraping manual link]: UPDATETHISLINKLATER/scraping-reddit/redditor.html
[submission comments scraping manual link]: UPDATETHISLINKLATER/scraping-reddit/submission-comments.html
[subreddit scraping manual link]: UPDATETHISLINKLATER/scraping-reddit/subreddit.html
[urs manual]: UPDATETHISLINKLATER
[wordcloud scraping manual link]: UPDATETHISLINKLATER/analytical-tools/frequencies-and-wordclouds.html#generating-wordclouds
[check praw rate limits manual link]: https://josephlai241.github.io/URS/utilities/rate-limit-checking.html
[contributing manual link]: https://josephlai241.github.io/URS/contributing/before-making-pull-or-feature-requests.html
[display directory tree manual link]: https://josephlai241.github.io/URS/utilities/tree.html
[frequencies scraping manual link]: https://josephlai241.github.io/URS/analytical-tools/frequencies-and-wordclouds.html#generating-word-frequencies
[livestream scraping manual link]: https://josephlai241.github.io/URS/livestreaming-reddit/general-information.html
[redditor scraping manual link]: https://josephlai241.github.io/URS/scraping-reddit/redditor.html
[submission comments scraping manual link]: https://josephlai241.github.io/URS/scraping-reddit/submission-comments.html
[subreddit scraping manual link]: https://josephlai241.github.io/URS/scraping-reddit/subreddit.html
[urs manual]: https://josephlai241.github.io/URS
[wordcloud scraping manual link]: https://josephlai241.github.io/URS/analytical-tools/frequencies-and-wordclouds.html#generating-wordclouds

<!-- PRAW SCRAPER DEMO GIFS -->

Expand Down
4 changes: 2 additions & 2 deletions manual/src/analytical-tools/frequencies-and-wordclouds.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,5 +70,5 @@ Exported files will be saved to the `analytics/wordclouds` directory.

Wordclouds are saved to file by default. If you do not want to keep a file, include the `--nosave` flag to only display the wordcloud.

[frequencies demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/analytical_tools/frequencies_generator_demo.gif
[wordcloud demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/analytical_tools/wordcloud_generator_demo.gif
[frequencies demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/analytical_tools/frequencies_generator_demo.gif?raw=true
[wordcloud demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/analytical_tools/wordcloud_generator_demo.gif?raw=true
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,6 @@ Reddit object information will be displayed in a PrettyTable as they are submitt

Include the `--nosave` flag if you do not want to save the livestream to file.

[livestream subreddit demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/live_scrapers/livestream_subreddit_demo.gif
[livestream subreddit demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/live_scrapers/livestream_subreddit_demo.gif?raw=true
[prettytable]: https://pypi.org/project/prettytable/
[subreddit stream disclaimer]: https://praw.readthedocs.io/en/latest/code_overview/other/subredditstream.html#praw.models.reddit.subreddit.SubredditStream
2 changes: 1 addition & 1 deletion manual/src/scraping-reddit/redditor.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ The file names will follow this format:

Scrape data is exported to the `redditors` directory.

[redditor demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/Redditor_demo.gif
[redditor demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/Redditor_demo.gif?raw=true
2 changes: 1 addition & 1 deletion manual/src/scraping-reddit/submission-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ Raw scrapes do not resemble comment threads, but returns all comments on a submi
You can export to raw format by including the `--raw` flag. `-raw` will also be appended to the end of the file name.

[depth-first search]: https://www.interviewcake.com/concept/java/dfs
[submission comments demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/submission_comments_demo.gif
[submission comments demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/submission_comments_demo.gif?raw=true
2 changes: 1 addition & 1 deletion manual/src/scraping-reddit/subreddit.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,4 +106,4 @@ If rules are included in your file, `-rules` will be appended to the end of the

After submitting the arguments and Reddit validation, `URS` will display a table of Subreddit scraping settings as a final check before executing. You can include the `-y` flag to bypass this and immediately scrape.

[subreddit demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/Subreddit_demo.gif
[subreddit demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/praw_scrapers/static_scrapers/Subreddit_demo.gif?raw=true
2 changes: 1 addition & 1 deletion manual/src/utilities/rate-limit-checking.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ You can quickly check the rate limits for your account by using this flag.
poetry run Urs.py --check
```

[check praw rate limits demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/utilities/check_rate_limit_demo.gif
[check praw rate limits demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/utilities/check_rate_limit_demo.gif?raw=true
2 changes: 1 addition & 1 deletion manual/src/utilities/tree.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,5 @@ The following date formats are supported:

An error is displayed if `URS` was not run on the entered date (if the date directory is not found within the `scrapes/` directory).

[display directory tree demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/utilities/tree_demo.gif
[display directory tree demo]: https://github.com/JosephLai241/URS/blob/demo-gifs/utilities/tree_demo.gif?raw=true
[nomad]: https://github.com/JosephLai241/nomad

0 comments on commit 6fb11da

Please sign in to comment.