Differentiate user info & user hello help messages (Fixes #51) #74
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
…esolves fedora-infra#51) This commit updates the help text for the user info and user hello commands within the FasHandler class. The descriptions are modified to accurately reflect the information provided by each command: user info: Returns detailed information about a Fedora user, including username, human name, pronouns, creation date, timezone, locale, and GPG key IDs. user hello: Returns a brief introduction of a Fedora user, including username, human name, and pronouns (if available). This clarifies the distinction between the commands and improves the user experience when interacting with the bot. Signed-off-by: [KimFarida] <[farimomoh@gmail.com]>
|
@ryanlerch could you please look into this? TIA. |
jeremycline
approved these changes
Apr 1, 2024
fedora/fas.py
Outdated
| @@ -178,11 +178,11 @@ async def user_hello(self, evt: MessageEvent, username: str | None) -> None: | |||
| """ | |||
| await self._user_hello(evt, username) | |||
|
|
|||
| @user.subcommand(name="info", help="Return brief information about a Fedora user.") | |||
| @user.subcommand(name="info", help="Return detailed information about a Fedora user, including username, human name, pronouns, creation date, timezone, locale, and GPG key IDs.") | |||
There was a problem hiding this comment.
I'm not sure if this repository enforces a line limit, but even if it doesn't it would be nice to break this up into multiple lines. You can split up text into multiple source code lines without inserting newlines by doing something like
@user.subcommand(
name="info",
help=(
"Return detailed information about a Fedora user, including username,"
" human name, pronouns, creation date, timezone, locale, and GPG key IDs."
),
)
There was a problem hiding this comment.
Oh? I thought didn't think too much too it. Thank you so much for reviewing, I will make the corrections now.
There was a problem hiding this comment.
@jeremycline I just made the corrections, thank you again for taking your time to look at my PRs. I am grateful.
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.
Description:
This PR updates the help text for the user info and user hello commands within the FasHandler class. The descriptions are now more accurate and clearly distinguish the information provided by each command:
user info: Returns detailed information about a Fedora user.
user hello: Returns a brief introduction of a Fedora user.
This improves the user experience by providing clearer guidance on how to use these commands.
Resolves: #51
Changes:
Modified help text for user info and user hello commands.
