question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Fix missing link targets in docs

See original GitHub issue

Since the BaseHTTPResponse split in #2083, various links in the docs are broken. Here’s how the Response Content looks like:

Screenshot 2021-08-18 at 11 34 23

There are other cases, eg. the API Reference doesn’t include the top-level functions, so disable_warnings() or request() are not documented.

To fix everything in one go, we need to enable Sphinx’s nitpicky mode. Despite the vague name, it only does one thing: warn about missing references. And since we treat Sphinx warnings as errors, this will allow us to fix those missing references and prevent any regressions in the future.

Here’s how Trio configures this nitpicky mode: https://github.com/python-trio/trio/blob/cb48b33a42b09dde955617f93923ed8f5fa02426/docs/source/conf.py#L39-L57

The process here, for each of the 78 failures is to figure out if:

  • the link is wrong and should be fixed,
  • the function exists and should be in the API Reference (in that case, add it somewhere in docs/reference),
  • or the link should be added to nitpicky_ignore.

It’s OK to open a PR that fixes only a few issues!

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5 (5 by maintainers)

github_iconTop GitHub Comments

3reactions
RatanShreshthacommented, Oct 5, 2021

I can pick this up

0reactions
pquentincommented, Oct 5, 2021

@RatanShreshtha It turns out @V1NAY8 opened https://github.com/urllib3/urllib3/pull/2416, so if he’s still interested please focus on a different file

Read more comments on GitHub >

github_iconTop Results From Across the Web

Work with links & bookmarks - Google Docs Editors Help
Open a document in Google Docs. ... Preferences. You can either: Turn on this setting: Check Show link details. Turn off this setting:...
Read more >
Links in HTML documents - W3C
Introduction to links and anchors. Visiting a linked resource; Other link relationships · The A element. Syntax of anchor names; Nested links are...
Read more >
Linking - Adobe Support
Click the folder icon to browse to and select the target file from which to unlink. If you are changing an e-mail, FTP,...
Read more >
Link plugin | Docs - TinyMCE
The link plugin allows a user to link external resources such as website URLs, to selected text in their document. It adds two...
Read more >
Redirects and Google Search | Documentation
You're merging two websites and want to make sure that links to outdated URLs are redirected to the correct pages. You removed a...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found