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

Add property descriptions to exported variables #28

Open
5 of 14 tasks
DeerTears opened this issue Mar 18, 2023 · 0 comments
Open
5 of 14 tasks

Add property descriptions to exported variables #28

DeerTears opened this issue Mar 18, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@DeerTears
Copy link
Member

DeerTears commented Mar 18, 2023

To make the whole experience easier for users, I'd like to add docstrings to all user-facing variables and options.

I've started on the config_folder tool, my goal is to have a short and sweet description that ideally answers 3 questions:

  1. What does this change about my final result?
  2. Does this option affect Godot or Trenchbroom?
  3. Is it optional? (Do I need to configure this for each map/project?)

If not all questions can be answered in 1-4 short sentences, link to the appropriate docs page: https://qodotplugin.github.io/

  • TrenchbroomGameConfig
  • TrenchbroomTag
  • TrenchbroomFaceAttrib
  • QodotFGDClass
  • QodotFGDBaseClass
  • QodotFGDFile
  • QodotFGDPointClass
  • QodotFGDSolidClass
  • QodotPlugin
  • QodotTextureLoader
  • QodotUtil
  • QodotMap
  • QodotEntity
  • QodotNode3D

I've written some class descriptions in https://qodotplugin.github.io/docs/class-reference (some are a bit wordy) and you are all free to copy, add, reword, and condense what's written into docstrings.

Here's how to add documentation to any property: https://docs.godotengine.org/en/latest/tutorials/scripting/gdscript/gdscript_documentation_comments.html Don't worry about adding special bbcode for now, we can always clean that stuff up later.

@DeerTears DeerTears added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Development

No branches or pull requests

1 participant