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

Document player mods #11

Merged
merged 7 commits into from
Nov 11, 2024
Merged

Document player mods #11

merged 7 commits into from
Nov 11, 2024

Conversation

wjt
Copy link
Member

@wjt wjt commented Nov 11, 2024

This adds a new sections to MODS.md, explaining all the parameters of Player, including those I added in #6 which have non-obvious names & semantics. Previously we were relying on the tooltips to explain what they mean but:

  1. Sometimes those don't show up, for unknown reasons.
  2. There's a limit to how much you can explain in a tooltip. For example, you can't link to the Wikipedia page about Wile E. Coyote from a tooltip to explain why Coyote Time is so called.

I also added a few miscellaneous linter & formatting tweaks, which are basically the same as:

The change in question was released in 4.3.0, released in August.
A minimal editorconfig to set the file encoding keeps being added to my
working copy – I think by Godot 4.4-dev3 – so let's commit it, and add
some potentially-useful rules for editing .gd files in external editors.
Previously, half of the README was wrapped at 80 characters, while the
other half used one long line per paragraph.

It doesn't really matter which style is used; but it's nice to be
consistent.
This improves the presentation of the player in the inspector.
For rationale, see
<https://turso.tech/blog/simple-trick-to-save-environment-and-money-when-using-github-actions>.

For the linting & formatting action, the concurrency group is set to
contain the PR (if any) and ref otherwise, on the basis that only the
latest push to a PR or branch is interesting.

For the GitHub Pages and Godot Asset Library actions, each run
overwrites the result of any previous run, so the concurrency group is
just the workflow name.
Copy link
Contributor

@manuq manuq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The explanation is great and the new linter keeps things consistent, thanks.

By the way, yes you can add a hyperlink to Wikipedia from a tooltip with:

[url]https://example.com[/url]
[url=https://example.com]Website[/url]

See https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html#bbcode-and-class-reference

@manuq manuq merged commit f797399 into main Nov 11, 2024
1 check passed
@manuq manuq deleted the push-ptqwslyzryqs branch November 11, 2024 17:07
@wjt
Copy link
Member Author

wjt commented Nov 11, 2024

Yes, but you can't click links in tooltips!

@manuq
Copy link
Contributor

manuq commented Nov 11, 2024

Yes, but you can't click links in tooltips!

Ah right. You can left-click the property and -> Open Documentation, where you can click on links. Hmm I'm not sure what is better. Having a MODS file for all the moddings. Or each class documenting its own moddings in the builtin documentation.

@wjt
Copy link
Member Author

wjt commented Nov 12, 2024

Hmm, OK, good point.

The nice thing about the MODS.md file is that it gives an overview of all the possibilities (in principle) in a single page. I don't think there is a way to make a page like https://docs.godotengine.org/en/4.3/tutorials/ui/index.html in the built-in documentation browser.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants