Skip to content

Commit

Permalink
Update how-to-develop-scraper.md
Browse files Browse the repository at this point in the history
slight doc formatting change
  • Loading branch information
jknndy committed Jun 8, 2024
1 parent a8453ca commit b55cf47
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/how-to-develop-scraper.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,10 @@ Where `ClassName` is the name that you used earlier to generate the scraper.
> It is also recommended that you manually test the scraper with a couple of different recipes from the website, to check that there aren't any special cases the scraper will need to handle. You don't need to create test cases for each of these.
## 6. Update the README
Add the website to the supported scraper list in README.rst, ensuring alphabetical order. If your site supports multiple top level domains (e.g. `.com.au`, `.co.ul`, `.at`, etc.) then list these on an indented entry under the primary domain (the default value of `host()` when no arguments are provided). For an example of this, check out the `hellofresh` listings.

Add the website's domain to the supported scraper list in README.rst, ensuring alphabetical order.

Check notice on line 210 in docs/how-to-develop-scraper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/how-to-develop-scraper.md#L210

Expected: 80; Actual: 98

If your site supports multiple top level domains (e.g. `.com.au`, `.co.ul`, `.at`, etc.) then list these on an indented entry under the primary domain (the default value of `host()` when no arguments are provided). For an example of this, check out the `hellofresh` listings.

Check notice on line 212 in docs/how-to-develop-scraper.md

View check run for this annotation

Codacy Production / Codacy Static Code Analysis

docs/how-to-develop-scraper.md#L212

Expected: 80; Actual: 275

## 7. Open a pull request

Expand Down

0 comments on commit b55cf47

Please sign in to comment.