Skip to content

ENH: use github issue form for doc improvement #43158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 0 additions & 22 deletions .github/ISSUE_TEMPLATE/documentation_improvement.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_improvement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Documentation Improvement
description: Report wrong or missing documentation
title: "DOC: "
labels: [Docs, Needs Triage]

body:
- type: checkboxes
attributes:
options:
- label: >
I have checked that the issue still exists on the latest versions of the docs
on `master` [here](https://pandas.pydata.org/docs/dev/)
required: true
- type: textarea
id: location
attributes:
label: Location of the documentation
description: >
Please provide the location of the documentation, e.g. "pandas.read_csv" or the
URL of the documentation, e.g.
"https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html"
placeholder: https://pandas.pydata.org/docs/reference/api/pandas.read_csv.html
validations:
required: true
- type: textarea
id: problem
attributes:
label: Documentation problem
description: >
Please provide a description of what documentation you believe needs to be fixed/improved
validations:
required: true
- type: textarea
id: suggested-fix
attributes:
label: Suggested fix for documentation
description: >
Please explain the suggested fix and **why** it's better than the existing documentation
validations:
required: true