Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] 2 typos + 1 clarification in docs #4288

Merged
merged 1 commit into from Jan 29, 2020
Merged

Conversation

petervandenabeele
Copy link
Contributor

@petervandenabeele petervandenabeele commented Jan 26, 2020

Fixing 2 small typos and adding 1 word as clarification in the downloader-middlewares.

Also, I was confused with the entries like ref:Reppy <reppy-parser> and similar entries.
Are these supposed to be links to other parts of the doc, or is this the intended way of showing these references ?

Fixing 2 small typos and adding 1 word as clarification in the downloader-middlewares.

Also, I was confused with the entries like `ref:Reppy <reppy-parser>` and similar entries.
Are these supposed to be links to other parts of the doc, or is this the intended way of showing these references ?
@codecov
Copy link

@codecov codecov bot commented Jan 26, 2020

Codecov Report

Merging #4288 into master will decrease coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #4288      +/-   ##
==========================================
- Coverage   83.91%   83.89%   -0.03%     
==========================================
  Files         166      166              
  Lines        9869     9869              
  Branches     1469     1469              
==========================================
- Hits         8282     8280       -2     
- Misses       1334     1335       +1     
- Partials      253      254       +1
Impacted Files Coverage Δ
scrapy/core/downloader/__init__.py 89.31% <0%> (-1.53%) ⬇️

@elacuesta
Copy link
Member

@elacuesta elacuesta commented Jan 27, 2020

I'm no Sphinx expert, but if I understand correctly :ref: directives create links to other sections.

:ref:`section`

sets the link text using the default name defined in the section itself, while

:ref:`Custom name <section>`

allows to override that text.

@kmike kmike merged commit 47b9de9 into scrapy:master Jan 29, 2020
2 checks passed
@kmike
Copy link
Member

@kmike kmike commented Jan 29, 2020

Thanks @petervandenabeele!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants