rapidsai / rapidsai/docs

[DOC] Copy text button not copying entire content

Open
#621 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

? - Needs Triage doc
Dominant language
HTML
Stars
52
Forks
73
Avg merge
4d 16m
Merged PRs (30d)
8

Description

Report incorrect documentation

Location of incorrect documentation
The first code box under the Examples section in:
https://docs.rapids.ai/api/cudf/stable/user_guide/api_docs/api/cudf.core.column.string.stringmethods.split/#cudf.core.column.string.StringMethods.split

Describe the problems or issues found in the documentation
The box contains this code:

import cudf
data = ["this is a regular sentence",
    "https://docs.python.org/index.html", None]
s = cudf.Series(data)
s
0            this is a regular sentence
1    https://docs.python.org/index.html
2                                  <NA>
dtype: object

clicking the copy button results in the following:

import cudf
data = ["this is a regular sentence",
s = cudf.Series(data)
s

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 linked cudf StringMethods.split documentation page and reproduce the problem with the first code box under Examples. Trace the documentation site's copy-button behavior and compare copied text with the full displayed block. Done means the button copies all of the code and output shown in that box.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.