rethinkdb / rethinkdb/docs

Wrong links under 'related commands'

Open
#1,290 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
CSS
Stars
118
Forks
161
PR merge metrics
No merged PRs in 30d

Description

Describe the bug
On the API page for hashMap the related command array points to the hashMap page again.

On the API page for forEach all related commands (next, toList, close (result)) point to the forEach page. Also, there is an inconsistency here, the document name does not correlate with the name of the Java command.

On the API page for toJsonString the related command json points to the toJsonString page again.

To Reproduce
Steps to reproduce the behavior:

  1. Go to the corresponding pages (see links above)
  2. Check the links under 'Related commands' at the bottom of the page

Expected behavior
Link to the correct page of the listed command.

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

Open the Java API pages for hashMap, forEach, and toJsonString named in the report, then inspect their Related commands links. Correct the links so array, next, toList, close (result), and json lead to their corresponding command pages, and verify each page no longer links back to itself.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.