Skip to content
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

docs (epic): overview of documentation changes #1754

Closed
braaar opened this issue Oct 4, 2022 · 2 comments
Closed

docs (epic): overview of documentation changes #1754

braaar opened this issue Oct 4, 2022 · 2 comments
Labels
type: fix Issues describing a broken feature.

Comments

@braaar
Copy link
Member

braaar commented Oct 4, 2022

Description

The goal of this issue is to have an easy to digest overview over docs changes to make it easier for maintainers to go through simple documentation changes.

Isn't this overview unnecessary since you can just filter the PRs for docs?
Not quite, since not everyone uses correct PR titles, and I think it helps that I have gone over the PRs and given them a quick look before I put them in the "ready for maintainer review" list. I've also tried to identify duplicates.

Where are the docstring changes?
Since docstrings are published as a part of this module, I think it makes sense to consider them as part of the product itself, whereas the documentation in the readme here in the repo is "just" documentation. I have chosen to put docstring changes as bugfixes in #1751

Proposed solution

Review and merge the open PRs that fix bugs

Ready for maintainer review

Need some work still (mostly just rebase/merge)

Don't have a PR yet

(comment if you know any other simple issues that should be tracked here!)
I'll try to look through issues to see if I can spot some.

@jotamorais

@braaar braaar added status: needs triage Issues which needs to be reproduced to be verified report. type: fix Issues describing a broken feature. labels Oct 4, 2022
@braaar
Copy link
Member Author

braaar commented Nov 21, 2022

I think this issue has outlived its usefulness by now

@braaar braaar closed this as completed Nov 21, 2022
@braaar braaar removed the status: needs triage Issues which needs to be reproduced to be verified report. label Nov 21, 2022
@github-actions
Copy link

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type: fix Issues describing a broken feature.
Development

No branches or pull requests

1 participant