diff options
author | Kamil Trzciński <ayufan@ayufan.eu> | 2016-12-15 21:39:53 +0000 |
---|---|---|
committer | Kamil Trzciński <ayufan@ayufan.eu> | 2016-12-15 21:39:53 +0000 |
commit | 026cef7ac2c827acba39761e708c054fd47fb51d (patch) | |
tree | 7f471a75dd6c5e7c58439a3c434a299ddf2f9b4d /lib | |
parent | b01a830afedeacfa099be5c3332f012c3d3db02c (diff) | |
parent | 70e72e8938b169f88e5b014500a9afeb6ff66a2b (diff) | |
download | gitlab-ce-026cef7ac2c827acba39761e708c054fd47fb51d.tar.gz |
Merge branch '25144-gitlab-ce-mattermost-slash-command-for-issue-create-needs-better-documentation' into 'master'
Resolve "gitlab-ce mattermost slash command for issue create needs better documentation"
## What does this MR do?
Updates the documentation and the <kbd>help</kbd> command to be clearer, having the keys used to add a newline in chat clients (both Mattermost and Slack).
## Are there points in the code the reviewer needs to double check?
* Are the available commands (via <kbd>help</kbd>) being formatted as `<code>` ?
## Why was this MR needed?
`\n` represents a new line character and doesn't communicate how the user should input the command. Also, to be correct, the documentation should use `<kbd>` instead of `<code>` for user input ([see HTML5 specification](https://www.w3.org/TR/html5/text-level-semantics.html#the-kbd-element))
## Screenshots (if relevant)
| Mattermost | Docs |
| --- | --- |
| ![image](/uploads/539526a14bfd551b7e732dd96c5b7581/image.png) | ![image](/uploads/e3eb099f86c5a32ce3b8954e72c29848/image.png) |
## Does this MR meet the acceptance criteria?
- [x] [Changelog entry](https://docs.gitlab.com/ce/development/changelog.html) added
- [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md)
- Tests
- [ ] All builds are passing
## What are the relevant issue numbers?
Closes #25144
See merge request !7850
Diffstat (limited to 'lib')
-rw-r--r-- | lib/gitlab/chat_commands/issue_create.rb | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/lib/gitlab/chat_commands/issue_create.rb b/lib/gitlab/chat_commands/issue_create.rb index 1dba85c1b51..cefb6775db8 100644 --- a/lib/gitlab/chat_commands/issue_create.rb +++ b/lib/gitlab/chat_commands/issue_create.rb @@ -8,7 +8,7 @@ module Gitlab end def self.help_message - 'issue new <title>\n<description>' + 'issue new <title> *`⇧ Shift`*+*`↵ Enter`* <description>' end def self.allowed?(project, user) |