Skip to content

Commit fde566c

Browse files
authored
Merge pull request #2741 from olitreadwell/chore/fix-typos-and-broken-link
Fix typos and two dead Nokogiri links
2 parents 6033032 + 9adefbb commit fde566c

8 files changed

Lines changed: 10 additions & 10 deletions

File tree

‎.github/ISSUE_TEMPLATE/documentation_bug.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Add a description about how the documentation should be
2424

2525
## Actual style
2626
<!--
27-
Add images or urls of the miss-formatted DevDocs documentation
27+
Add images or urls of the mis-formatted DevDocs documentation
2828
-->
2929

3030
## Expected style

‎docs/filter-reference.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The `call` method must return either `doc` or `html`, depending on the type of f
3131

3232
* `doc` [Nokogiri::XML::Node]
3333
The Nokogiri representation of the container element.
34-
See [Nokogiri's API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node) for the list of available methods.
34+
See [Nokogiri's API docs](https://nokogiri.org/rdoc/Nokogiri/XML/Node.html) for the list of available methods.
3535

3636
* `html` [String]
3737
The string representation of the container element.
@@ -96,7 +96,7 @@ Scrapers can have any number of custom filters but require at least the two desc
9696

9797
The `CleanHtml` filter is tasked with cleaning the HTML markup where necessary and removing anything superfluous or nonessential. Only the core documentation should remain at the end.
9898

99-
Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](http://www.rubydoc.info/github/sparklemotion/nokogiri/Nokogiri/XML/Node).
99+
Nokogiri's many jQuery-like methods make it easy to search and modify elements — see the [API docs](https://nokogiri.org/rdoc/Nokogiri/XML/Node.html).
100100

101101
Here's an example implementation that covers the most common use-cases:
102102

@@ -159,7 +159,7 @@ Each scraper must implement its own `EntriesFilter` by subclassing the [`Docs::E
159159

160160
* `include_default_entry?` [Boolean]
161161
Whether to include the default entry.
162-
Used when a page consists of multiple entries (returned by `additional_entries`) but doesn't have a name/type of its own, or to remove a page from the index (if it has no additional entries), in which case it won't be copied on the local filesystem and any link to it in the other pages will be broken (as explained on the [Scraper Reference](./scraper-reference.md) page, this is used to keep the `:skip` / `:skip_patterns` options to a maintainable size, or if the page includes links that can't reached from anywhere else).
162+
Used when a page consists of multiple entries (returned by `additional_entries`) but doesn't have a name/type of its own, or to remove a page from the index (if it has no additional entries), in which case it won't be copied on the local filesystem and any link to it in the other pages will be broken (as explained on the [Scraper Reference](./scraper-reference.md) page, this is used to keep the `:skip` / `:skip_patterns` options to a maintainable size, or if the page includes links that can't be reached from anywhere else).
163163
**Default:** `true`
164164

165165
* `additional_entries` [Array]

‎docs/maintainers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This document is intended for [DevDocs maintainers](#list-of-maintainers).
1212

1313
## Updating docs
1414

15-
The process for updating docs is as follow:
15+
The process for updating docs is as follows:
1616

1717
- Follow the checklist in [CONTRIBUTING.md#updating-existing-documentations](../.github/CONTRIBUTING.md#updating-existing-documentations).
1818
- Commit the changes (protip: use the `thor docs:commit` command documented below).

‎docs/scraper-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Configuration is done via class attributes and divided into three main categorie
8585

8686
Each scraper has two [filter](https://github.com/freeCodeCamp/devdocs/blob/main/lib/docs/core/filter.rb) [stacks](https://github.com/freeCodeCamp/devdocs/blob/main/lib/docs/core/filter_stack.rb): `html_filters` and `text_filters`. They are combined into a pipeline (using the [HTML::Pipeline](https://github.com/jch/html-pipeline) library) which causes each filter to hand its output to the next filter's input.
8787

88-
HTML filters are executed first and manipulate a parsed version of the document (a [Nokogiri](http://nokogiri.org/Nokogiri/XML/Node.html) node object), whereas text filters manipulate the document as a string. This separation avoids parsing the document multiple times.
88+
HTML filters are executed first and manipulate a parsed version of the document (a [Nokogiri](https://nokogiri.org/rdoc/Nokogiri/XML/Node.html) node object), whereas text filters manipulate the document as a string. This separation avoids parsing the document multiple times.
8989

9090
Filter stacks are like sorted sets. They can be modified using the following methods:
9191

‎lib/docs/filters/eslint/entries.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def get_type
1111
return 'Rules'
1212
else
1313
type = at_css('nav.docs-index [aria-current="true"]').ancestors('li')[-1].at_css('a').content
14-
# This specific entry is mispelled with a lowercase 'i'
14+
# This specific entry is misspelled with a lowercase 'i'
1515
if type.start_with?('integrate')
1616
type = type.sub('integrate', 'Integrate')
1717
end

‎lib/docs/filters/pandas/clean_html.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ def call
1111

1212
css('form').remove
1313

14-
# add ':' to '.classifier' clases
14+
# add ':' to '.classifier' classes
1515
css('.classifier').each do |node|
1616
text = node.content
1717
node.content = ':' + text

‎lib/docs/filters/redis/entries.rb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -487,7 +487,7 @@ def get_type
487487
"list" => "Core: List",
488488
"pubsub" => "Core: Pub/Sub",
489489
"scripting" => "Core: Scripting and Functions",
490-
"server" => "Core: Server managment",
490+
"server" => "Core: Server management",
491491
"set" => "Core: Set",
492492
"sorted-set" => "Core: Sorted Set",
493493
"stream" => "Core: Stream",

‎lib/tasks/updates.thor‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class UpdatesCLI < Thor
2323
option :verbose, :type => :boolean
2424
def check(*names)
2525
# Convert names to a list of Scraper instances
26-
# Versions are omitted, if v10 is outdated than v8 is aswell
26+
# Versions are omitted, if v10 is outdated than v8 is as well
2727
docs = names.map {|name| Docs.find(name.split(/@|~/)[0], false)}.uniq
2828

2929
# Check all documentations for updates when no arguments are given

0 commit comments

Comments
 (0)