cmddocsgen: note un/nick hist cmds disabled #1765
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: SoggySaussages <[email protected]>
l-zeuch
reviewed
Nov 15, 2024
| @@ -30,6 +31,12 @@ func (p *Plugin) AddCommands() { | |||
| commands.AddRootCommands(p, cmdLogs, cmdWhois, cmdNicknames, cmdUsernames, cmdClearNames) | |||
| } else { | |||
| commands.AddRootCommands(p, cmdLogs, cmdWhois) | |||
| if run.FlagGenCmdDocs { | |||
| for _, cmd := range []*commands.YAGCommand{cmdNicknames, cmdUsernames, cmdClearNames} { | |||
| cmd.Description = fmt.Sprint(cmd.Description, " Disabled on the public instance.") | |||
There was a problem hiding this comment.
Perhaps "disabled on this instance" instead? Though I'm not sure if the average self-hoster bothers to host their own docs, let alone generate command docs, so maybe not, plus it is questionable whether it makes sense for users reading our documentation what we even mean by "this instance".
There was a problem hiding this comment.
That's my thought as well, if you're using gencmddocs you can always mod the source code.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When generating command docs with username logging config disabled, instead of omitting the relevant commands as is the current behaviour, this PR adds a note mentioning the relevant commands are disabled on the public instance. This
allows for unaffected command docs to be generated including the commands in question on an instance running nickname
logging. For instances with username logging disabled, the docs generate for the benefit of downstream forks using the
upstream's docs while informing it's own users it won't be accessible.
Signed-off-by: SoggySaussages [email protected]