Skip to content

Commit d1b8ffe

Browse files
committed
Fix typos and grammar in docs and issue templates
1 parent fde566c commit d1b8ffe

5 files changed

Lines changed: 5 additions & 5 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If possible fill each section
1313
# Bug report
1414

1515
<!--
16-
Verify this steps before writing a new issue:
16+
Verify these steps before writing a new issue:
1717
1818
- Search for existing issues; it's possible someone has already encountered this bug.
1919
-->

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ If possible fill each section
1313
# Feature request
1414

1515
<!--
16-
Verify this steps before suggesting a new feature:
16+
Verify these steps before suggesting a new feature:
1717
1818
- Check if anyone has suggested this feature before
1919
https://github.com/freeCodeCamp/devdocs/labels/feature

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ thor console:docs # Start a REPL in the "Docs" module
148148
thor test:all # Run all tests
149149
thor test:docs # Run "Docs" tests
150150
thor test:app # Run "App" tests
151-
thor test:coverage # Run coverage report on "App" tests
151+
thor test:coverage # Run coverage report for core tests
152152

153153
# Assets
154154
thor assets:compile # Compile assets (not required in development mode)

‎docs/adding-docs.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@ Adding a documentation may look like a daunting task but once you get the hang o
1919
12. Add the documentation's copyright details to `options[:attribution]`. This is the data shown in the table on the [about](https://devdocs.io/about) page, and is ordered alphabetically. Please see an existing scraper for the typesetting.
2020
13. Ensure `thor updates:check [my_doc]` shows the correct latest version.
2121

22-
If the documentation includes more than a few hundreds pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
22+
If the documentation includes more than a few hundred pages and is available for download, try to scrape it locally (e.g. using `FileScraper`). It'll make the development process much faster and avoids putting too much load on the source site. (It's not a problem if your scraper is coupled to your local setup, just explain how it works in your pull request.)
2323

2424
Finally, try to document your scraper and filters' behavior as much as possible using comments (e.g. why some URLs are ignored, HTML markup removed, metadata that way, etc.). It'll make updating the documentation much easier.

‎docs/filter-reference.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
## Overview
1111

12-
Filters use the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. They take an HTML string or [Nokogiri](http://nokogiri.org/) node as input, optionally perform modifications and/or extract information from it, and then outputs the result. Together they form a pipeline where each filter hands its output to the next filter's input. Every documentation page passes through this pipeline before being copied on the local filesystem.
12+
Filters use the [HTML::Pipeline](https://github.com/jch/html-pipeline) library. They take an HTML string or [Nokogiri](http://nokogiri.org/) node as input, optionally perform modifications and/or extract information from it, and then output the result. Together they form a pipeline where each filter hands its output to the next filter's input. Every documentation page passes through this pipeline before being copied on the local filesystem.
1313

1414
Filters are subclasses of the [`Docs::Filter`](https://github.com/freeCodeCamp/devdocs/blob/main/lib/docs/core/filter.rb) class and require a `call` method. A basic implementation looks like this:
1515

0 commit comments

Comments
 (0)