ruby / ruby/rdoc

Broken links in documentation

Open
#763 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

https://ruby-doc.org/stdlib-2.7.0/libdoc/rexml/rdoc/REXML/DTD/ElementDecl.html

Screen Shot 2020-04-07 at 12 09 22 AM
<p>s*(((([“‘]).*?<a href=”^/’“>”>5)|</a>*)*?)(/)?&gt;/um, true)</p>

https://ruby-doc.org/stdlib-2.7.0/libdoc/net/ftp/rdoc/Net/FTP.html
Screen Shot 2020-04-07 at 12 11 54 AM

<p>The available options are:</p>
<dl class="rdoc-list note-list"><dt>port
<dd>
<p>Port number (default value is 21)</p>
</dd><dt>ssl
<dd>
<p>If <a href=":ssl">options</a> is true, then an attempt will be made to use
SSL (now TLS) to connect to the server.  For this to work <a
href="FTP/OpenSSL.html">OpenSSL</a> [OSSL] and the Ruby <a
href="FTP/OpenSSL.html">OpenSSL</a> [RSSL] extensions need to be installed.
If <a href=":ssl">options</a> is a hash, it’s passed to
OpenSSL::SSL::SSLContext#set_params as parameters.</p>
</dd><dt>private_data_connection
<dd>
<p>If true, TLS is used for data connections. Default: <code>true</code> when
<a href=":ssl">options</a> is true.</p>
</dd><dt>username
<dd>
<p>Username for login.  If <a href=":username">options</a> is the string
“anonymous” and the <a href=":password">options</a> is <code>nil</code>,
“anonymous@” is used as a password.</p>
</dd><dt>password
<dd>
<p>Password for login.</p>

All of these hrefs are wrong. I'm not exactly sure what they're supposed to be.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the two generated documentation pages linked in the report and compare each broken href with the surrounding RDoc markup shown in the issue. The intended replacement targets are not specified, so confirm the correct destinations before changing anything, then verify that all reported links resolve correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.