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

Documentation Backlog #729

Open
robojumper opened this issue Jan 18, 2020 · 2 comments
Open

Documentation Backlog #729

robojumper opened this issue Jan 18, 2020 · 2 comments
Labels
de-private/const Removes private/protected* or const from variables doc-one-line-fix Fix that needs only one line in documentation docs needs-docs Needs documentation

Comments

@robojumper
Copy link
Member

I went through all past issues and tagged labelled them when I determined that they need documentation. First of all, every issue that made changes to base game code (and did not fix a HL bug) has one of the three labels needs-docs, de-private/const, doc-one-line-fix. Here's what they mean:

  • needs-docs: This issue needs a full documentation page.
  • de-private/const: Unspectacular change that only de-((private|protected)write?|const)-s a variable). Could possibly be merged into one page.
  • doc-one-line-fix: A bug fix that can be described in a single line, does not need example code nor "how to use" docs and should probably also be merged into one page with a big list.

I've applied the labels to my best judgement, but it's possible to upgrade/downgrade the labels ("this deserves a full documentation page because...") later (when reviewing the PR that adds documentation, for example). We won't miss any issues because all issues that should be documented in any form have one of the labels.

Note that the docs script will need special handling for the consolidated pages.

@robojumper robojumper added needs-docs Needs documentation de-private/const Removes private/protected* or const from variables doc-one-line-fix Fix that needs only one line in documentation labels Jan 18, 2020
@robojumper
Copy link
Member Author

Prefer the links in this issue for a list of issues to document, as clicking the colorful GitHub labels will take you to a search page that only shows open, not closed issues.

@pledbrook
Copy link
Contributor

I'm confused. The links in the issue description seem to take me to exactly the same page as clicking on the labels. By the way, mad respect for labelling all the issues!

@robojumper robojumper added the docs label Mar 4, 2020
@Xymanek Xymanek pinned this issue Jun 23, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
de-private/const Removes private/protected* or const from variables doc-one-line-fix Fix that needs only one line in documentation docs needs-docs Needs documentation
Projects
None yet
Development

No branches or pull requests

2 participants