Skip to content

Commit

Permalink
Update readme documentation for parser (#383)
Browse files Browse the repository at this point in the history
  • Loading branch information
hartsick authored Aug 31, 2023
1 parent bd824c0 commit dfbf65f
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -335,18 +335,21 @@ There are rake tasks for a few tasks (besides Rails' default ones). Run them thi

```ruby
module Parser
class <Provider><Type> < Base
class <Provider><Type> < Base
class << self
def type
'<provider>_<type>'.freeze
end

def patterns
# A list of regex that tell us when we've landed on a URL for this parser, eg facebook.com
[<list of URL patterns>]
end

def ignored_urls
# Optional method to specify disallowed URLs
# Optional method to specify disallowed URLs. We generally use this to detect
# when we've been redirected to a dead end, like a login page.
#
# Should return an array in format:
# [
# {
Expand Down

0 comments on commit dfbf65f

Please sign in to comment.