Jannyboy11 / InvSee-plus-plus

A bukkit plugin for manipulating player inventories
Other
92 stars 18 forks source link

Use "[argument]" instead of "<argument>?" #60

Closed saccf0 closed 1 year ago

saccf0 commented 1 year ago

The standards suggest this change:

Jannyboy11 commented 1 year ago

Should be [<argument>] then, right? Because the fish brackets indicate it is a placeholder. '[argument]' would mean the literal "argument", optionally.

Which standard are you referring to, anyway?

saccf0 commented 1 year ago

Yes, I forgot about the placeholder. The standards are here: http://courses.cms.caltech.edu/cs11/material/general/usage.html#:~:text=Optional%20arguments%20should%20always%20be,an%20argument%20is%20optional%2C%20always.

I'll fix my mistake with the placeholder when I find some time.

Jannyboy11 commented 1 year ago

I think it's probably best to adhere to the usage string syntax that vanilla Minecraft itself uses as well: https://minecraft.fandom.com/wiki/Commands#Syntax (which coincidentally seems to be the same as the syntax that you're proposing). The only convention that I want to divert from is the usage of camelCase to concatenate words in a placeholder, I think names with spaces are better.

Jannyboy11 commented 1 year ago

You are missing the changes in the README.md by the way; the command usages are written there as well.

Jannyboy11 commented 1 year ago

Do you still plan to address my requested changes, or should I make the changes myself?

saccf0 commented 1 year ago

I will make the changes later today. So you're requesting [optional] or [<optional>] for optional arguments?

Jannyboy11 commented 1 year ago

Either you didn't read my comments, or you are just trolling now. My earlier comments clearly state that it should be [<argument>] for optional arguments indicated with placeholders. [argument] is only for optional literals.

Jannyboy11 commented 1 year ago

https://github.com/Jannyboy11/InvSee-plus-plus/commit/620c7c41c743ded67d3dec868d20c69acddc0ab0