Skip to content

Commit

Permalink
Correct tag
Browse files Browse the repository at this point in the history
  • Loading branch information
madeindjs committed Jul 31, 2018
1 parent 7f364f2 commit 05d81ac
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions src/configuration.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
/// Structure to configure `Website` crawler
/// ~~~rust
/// <pre>
/// let mut website: Website = Website::new("https://choosealicense.com");
/// website.configuration.blacklist_url.push("https://choosealicense.com/licenses/".to_string());
/// website.configuration.respect_robots_txt = true;
/// website.configuration.verbose = true;
/// localhost.crawl();
/// ~~~
/// </pre>
#[derive(Debug)]
pub struct Configuration {
/// Respect robots.txt file and not scrape not allowed files (not implemented)
Expand Down
8 changes: 4 additions & 4 deletions src/website.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@ use configuration::Configuration;
use robotparser::RobotFileParser;

/// Represent a website to scrawl. To start crawling, instanciate a new `struct` using
/// ~~~rust
/// <pre>
/// let mut localhost = Website::new("http://example.com");
/// localhost.crawl();
/// ~~~
/// </pre>
/// `Website` will be filled with `Pages` when crawled. To get them, just use
/// ~~~rust
/// <pre>
/// for page in localhost.get_pages() {
/// // do something
/// }
/// ~~~
/// </pre>
#[derive(Debug)]
pub struct Website<'a> {
// configuration properies
Expand Down

0 comments on commit 05d81ac

Please sign in to comment.