Skip to content

Document /flycommand:fly in the user guide and command reference - #35

Merged
dmccoystephenson merged 1 commit into
mainfrom
feature/document-namespaced-fly
Oct 30, 2026
Merged

dmccoystephenson merged 1 commit into
mainfrom
feature/document-namespaced-fly

Conversation

@dmccoystephenson

Copy link
Copy Markdown
Member

Summary

  • USER_GUIDE.md and COMMANDS.md are updated to state that /flycommand:fly is handled the same as /fly, and that FlyCommand is still reached through it when /fly is also registered by another plugin (for example EssentialsX).
  • A matching bullet is added to CHANGELOG.md under ## [Unreleased].

Support for the namespaced form was shipped in 1.0.0 (#13) and is already covered by the README's tests and manual-validation sections, but it was not mentioned in the two guides read by server admins, and it is the form needed when a /fly conflict exists.

No tracking issue: the gap was found during a documentation accuracy sweep. The open-issue backlog was empty at triage, so no issues were deferred.

Sweep coverage

README.md, USER_GUIDE.md, COMMANDS.md, CONFIG.md, CHANGELOG.md, CONTRIBUTING.md, plugin.yml, pom.xml, .gitignore, minecraft-versions.json and the three workflows were checked against Main.java, the tests and the remote tags (v1.0.0, dev). No other drift was found.

Validation

Only docs are changed; code and manifest are left untouched. Each claim was checked against the source:

  • At src/main/java/me/Daniel/FlyCommand/Main.java:22, command.getName().equalsIgnoreCase("fly") is matched, not the typed label, so every label that resolves to the command is handled.
  • In FlyCommandTest.otherLabelsForTheCommandAlsoToggleFlight, the handler is already run with the label flycommand:fly, and flight is asserted to toggle.
  • The prefix flycommand is derived from name: FlyCommand in plugin.yml, lower-cased, as the standard Bukkit fallback prefix.

The Build workflow (Maven compile, tests and API-compat check) is run on this PR as usual, although no code or manifest is changed.

This PR description was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).

🤖 Generated with Claude Code


drafted by Claude on behalf of Daniel Stephenson

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dmccoystephenson

Copy link
Copy Markdown
Member Author

Self-review rubric (scored adversarially against the diff and command output):

  • Scope: PASS. Only USER_GUIDE.md, COMMANDS.md and CHANGELOG.md are modified, each with a line about /flycommand:fly; no unrelated churn.
  • Validation-new: PASS. The documented behaviour is exercised by the existing FlyCommandTest.otherLabelsForTheCommandAlsoToggleFlight (label flycommand:fly) and by README manual-validation step 5; the build check (Maven compile, tests, API check) passed on this head in 23s.
  • Validation-fix: not applicable. No bug fix is included; the change is documentation-only.
  • Sibling structure: PASS. No new files; the existing table row and prose paragraph style are kept.
  • Sibling renames: not applicable. Nothing is renamed.
  • Docs: PASS, with one judgment call. The README ## Usage section still mentions only /fly. It is left as is because the README is a summary that links to the user guide, and /flycommand:fly is already named in its Testing and Manual Validation sections, so it is not inaccurate.
  • Issue resolution: not applicable. No Closes reference; this is a sweep finding, as stated in the PR body.
  • Manual validation / anchor: PASS. Main.java:22 matches on command.getName(); the flycommand prefix is derived from name: FlyCommand; build is green on d576ef8.
  • Manifest/command/main-class declaration: unchanged. plugin.yml and Main.java are not touched.
  • No stack change: PASS. No pom.xml, workflow or dependency change.
  • Changelog: PASS. A bullet is added under ## [Unreleased] / ### Added.
  • No harness leakage: PASS. git diff --name-only lists only the three docs.
  • Do-not-auto-merge paths: none matched (no workflow, security/, Main.java, plugin.yml, .github/copilot-instructions.md or LICENSE change; no file has more than 50 lines deleted).

Summary: a documentation-only change, verified against the source and the existing tests, with CI green. No changes are requested.

This review comment was drafted during a Gardener session (https://github.com/Stephenson-Software/gardener).


drafted by Claude on behalf of Daniel Stephenson

@dmccoystephenson
dmccoystephenson merged commit 4997c96 into main Oct 30, 2026
1 check passed
@dmccoystephenson
dmccoystephenson deleted the feature/document-namespaced-fly branch October 30, 2026 03:48
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.

1 participant