From 6a7edc45cc5f2433194f0e4095221d1858e48f09 Mon Sep 17 00:00:00 2001 From: Matthew Zeitlin Date: Sat, 21 Aug 2021 12:15:03 -0400 Subject: [PATCH 1/2] ENH: use github issue form for doc improvement --- .../documentation_improvement.md | 22 ---------- .../documentation_improvement.yaml | 40 +++++++++++++++++++ 2 files changed, 40 insertions(+), 22 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/documentation_improvement.md create mode 100644 .github/ISSUE_TEMPLATE/documentation_improvement.yaml diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.md b/.github/ISSUE_TEMPLATE/documentation_improvement.md deleted file mode 100644 index 3351ff9581121..0000000000000 --- a/.github/ISSUE_TEMPLATE/documentation_improvement.md +++ /dev/null @@ -1,22 +0,0 @@ ---- - -name: Documentation Improvement -about: Report wrong or missing documentation -title: "DOC:" -labels: "Docs, Needs Triage" - ---- - -#### Location of the documentation - -[this should 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"] - -**Note**: You can check the latest versions of the docs on `master` [here](https://pandas.pydata.org/docs/dev/). - -#### Documentation problem - -[this should provide a description of what documentation you believe needs to be fixed/improved] - -#### Suggested fix for documentation - -[this should explain the suggested fix and **why** it's better than the existing documentation] diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.yaml b/.github/ISSUE_TEMPLATE/documentation_improvement.yaml new file mode 100644 index 0000000000000..614afe3e90512 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation_improvement.yaml @@ -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: > + This should 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: > + This should 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: > + This should explain the suggested fix and **why** it's better than the existing documentation + validations: + required: true From 2a53555bf9675676a4cd6c9ac68a1157316c50b7 Mon Sep 17 00:00:00 2001 From: Matthew Zeitlin Date: Sat, 21 Aug 2021 16:48:41 -0400 Subject: [PATCH 2/2] This should -> please --- .github/ISSUE_TEMPLATE/documentation_improvement.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation_improvement.yaml b/.github/ISSUE_TEMPLATE/documentation_improvement.yaml index 614afe3e90512..97897c3224f91 100644 --- a/.github/ISSUE_TEMPLATE/documentation_improvement.yaml +++ b/.github/ISSUE_TEMPLATE/documentation_improvement.yaml @@ -16,7 +16,7 @@ body: attributes: label: Location of the documentation description: > - This should provide the location of the documentation, e.g. "pandas.read_csv" or the + 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 @@ -27,7 +27,7 @@ body: attributes: label: Documentation problem description: > - This should provide a description of what documentation you believe needs to be fixed/improved + Please provide a description of what documentation you believe needs to be fixed/improved validations: required: true - type: textarea @@ -35,6 +35,6 @@ body: attributes: label: Suggested fix for documentation description: > - This should explain the suggested fix and **why** it's better than the existing documentation + Please explain the suggested fix and **why** it's better than the existing documentation validations: required: true