pyjanitor-devs/pyjanitor

[DOC] janitor.functions text on API docs is not a clickable link

Open

#381 opened on May 28, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (1,217 stars) (164 forks)batch import
available for hackingdocfixgood first issue

Description

https://pyjanitor.readthedocs.io/reference/index.html

janitor.[biology,chemistry,finance] are.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic knowledge of Python documentation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine the documentation source for 'janitor.functions' on ReadTheDocs. The issue states that 'janitor.[biology,chemistry,finance]' are clickable links, but 'janitor.functions' is not. Locate the relevant file (likely in docs/reference or similar) and add the appropriate hyperlink markup to make the text clickable, following the pattern of the working links. Check the existing docs structure for consistency.