search

IntellectualSites / documentation

A collection of documentation sources for our plugins hosted on gitbook
https://intellectualsites.gitbook.io/
MIT License
4 stars 7 forks source link

Fix inadequate documentation of commands "move", "copy", and "swap". #108

Closed ProjectHSI closed 3 months ago

ProjectHSI commented 4 months ago

Overview

The commands "move", "copy" and "swap" have had documentation modified as part of this PR.

I think this will clear up some confusion as apart of these commands while keeping with the original documentation format. Mainly that I accidentally deleted a plot due to this inadequate documentation 🙃.

Description

The commands "move", "copy" and "swap" have had documentation modified as part of this commit.

### Submitter Checklist
- [x] Make sure you are opening from a topic branch (**/feature/fix/docs/ branch** (right side)) and not your main branch.
- [x] Ensure that the pull request title represents the desired changelog entry.
- [x] New public fields and methods are annotated with `@since TODO`.
- [x] I read and followed the [contribution guidelines](https://github.com/IntellectualSites/.github/blob/main/CONTRIBUTING.md).
RedstoneFuture commented 4 months ago

Hi.

I think the plots.admin permission is useful for so much features, that it is enough if it is listed here. It doesn't help to specify them individually everywhere again. This is not a "normal application-related" permission.

ProjectHSI commented 4 months ago

@RedstoneFuture fixed - removed the admin permissions reference from those

RedstoneFuture commented 3 months ago

Since the optional plot arguments are part of some other commands, I have suggested a revision with a different spelling in a separate PR.

The plot that was specified after the command will be replaced with the plot you are in or have specified before the command. Actually, everything is part of the command. There is no "before". But I know what you mean.

In any case: thanks for the suggestion.