Skip to content

Commit 886291e

Browse files
committed
docs/buttons: Expand PMs to Private Messages in documentation.
Using abbreviations can be confusing, particularly for new users, and is ideally avoided during most discussions and documentation. In addition, an abbreviated form is not used for stream-messages, so it is also clearer if both are written out in full. This does not update any similar abbreviations in the code, except in the docstring of buttons.py, which is used to autogenerate the developer-file-overview.md file. NOTE: This commit is in preparation for an intended upcoming change to use 'Direct Messages' for this naming in #1288.
1 parent e76fb5a commit 886291e

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

docs/FAQ.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,7 +204,7 @@ Since each of the stream (1), topic (2) and private message recipients (3) areas
204204

205205
![PM recipients header](https://user-images.githubusercontent.com/55916430/118403345-9d422800-b68b-11eb-9005-6d2af74adab9.png)
206206

207-
**NOTE:** If a PM recipient's name contains comma(s) (`,`), they are currently treated as comma-separated recipients.
207+
**NOTE:** If a private message recipient's name contains comma(s) (`,`), they are currently treated as comma-separated recipients.
208208

209209
## Unable to render symbols
210210

docs/developer-feature-tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,8 @@ You can view these events in the `type` file in your `zulip-terminal` home direc
103103

104104
Now to display if user is typing in the view, we need to check few things:
105105
* The `op` is `start`.
106-
* User is narrowed into PM with a user.
107-
* The `user_id` of the person is present in the narrowed PM recipients.
106+
* User is narrowed into private message conversation with a user.
107+
* The `user_id` of the person is present in the narrowed private message conversation recipients.
108108

109109
If all the above conditions are satisfied we can successfully update the footer to display `X is typing` until we receive
110110
a `stop` event for typing.

docs/developer-file-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Zulip Terminal uses [Zulip's API](https://zulip.com/api/) to store and retrieve
3030
| | ui_sizes.py | Fixed sizes of UI elements |
3131
| | | |
3232
| zulipterminal/ui_tools | boxes.py | UI boxes for displaying messages and entering text, such as `MessageBox`, `SearchBox`, `WriteBox`, etc.|
33-
| | buttons.py | UI buttons for 'narrowing' and showing unread counts, such as Stream, PM, Topic, Home, Starred, etc |
33+
| | buttons.py | UI buttons for 'narrowing' & showing unread counts, eg. All, Stream, Private message, Topic, Starred |
3434
| | tables.py | Helper functions which render tables in the UI |
3535
| | utils.py | The `MessageBox` for every message displayed is created here |
3636
| | views.py | UI views for larger elements such as Streams, Messages, Topics, Help, etc |

docs/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Zulip Terminal User Tutorial
44

5-
Hi, are you new to [Zulip](https://github.com/zulip/zulip)? If so, we recommend trying out our [web-client](https://chat.zulip.org) first to understand the concept of [streams/topics/PMs](https://zulip.com/help/about-streams-and-topics) in the world of Zulip. Please read through our [community docs](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) to get a feel for how things work. Just sending a message or two in the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream should help you get started. If you don't already have a Zulip account, you'll also have to use our [web-client](https://chat.zulip.org) to sign up because currently you can't create an account using Zulip Terminal.
5+
Hi, are you new to [Zulip](https://github.com/zulip/zulip)? If so, we recommend trying out our [web-client](https://chat.zulip.org) first to understand the concept of [streams and topics](https://zulip.com/help/about-streams-and-topics) in the world of Zulip. Please read through our [community docs](https://zulip.readthedocs.io/en/latest/contributing/chat-zulip-org.html) to get a feel for how things work. Just sending a message or two in the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream should help you get started. If you don't already have a Zulip account, you'll also have to use our [web-client](https://chat.zulip.org) to sign up because currently you can't create an account using Zulip Terminal.
66

77
Now let's help you get started with using Zulip Terminal. First, if you haven't already, go ahead and complete the [installation](https://github.com/zulip/zulip-terminal#installation). If you encountered any issues, we have common issues and their solutions listed [here](https://github.com/zulip/zulip-terminal/blob/main/docs/FAQ.md) if you run into trouble. Feel free to ask questions or for help at [#zulip-terminal](https://chat.zulip.org/#narrow/stream/206-zulip-terminal) or support@zulip.com.
88

@@ -124,7 +124,7 @@ You can also type <kbd>z</kbd> to 'zoom in' or 'zoom out.' What do I mean by 'zo
124124

125125
### Reply to a Message
126126

127-
To reply to a message in a narrow (stream/topic/PM), rest your cursor on the message you want to reply to and then type <kbd>r</kbd>. Type your message in the Message box that pops up at the bottom of the middle column. Type <kbd>ctrl</kbd><kbd>d</kbd> to send. If you change your mind and don't want to send the message, type <kbd>esc</kbd> to get out of the message editor. Let's try replying to a random message in the **[#test here](https://chat.zulip.org/#narrow/stream/7-test-here)** stream (don't worry about messing anything up, the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream was made for stuff like this).
127+
To reply to an existing stream- or private-message in any narrow, rest your cursor on the message you want to reply to and then type <kbd>r</kbd>. Type your message in the Message box that pops up at the bottom of the middle column. Type <kbd>ctrl</kbd><kbd>d</kbd> to send. If you change your mind and don't want to send the message, type <kbd>esc</kbd> to get out of the message editor. Let's try replying to a random message in the **[#test here](https://chat.zulip.org/#narrow/stream/7-test-here)** stream (don't worry about messing anything up, the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream was made for stuff like this).
128128

129129
<img src="getting-started-imgs/reply-to-message.png" width="85%">
130130

@@ -136,19 +136,19 @@ If you want to show you agree with the current message, type <kbd>+</kbd> to add
136136

137137
### Reply via a Private Message
138138

139-
Let's try sending a PM to the author of a message. Select the message you sent to the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream earlier and press <kbd>shift</kbd><kbd>r</kbd> to send a PM to yourself. Type your message in the message editor that appears at the bottom of the middle column and then type <kbd>ctrl</kbd><kbd>d</kbd> to send. Press the <kbd>shift</kbd><kbd>p</kbd> hotkey as we did earlier in the tutorial to narrow to your PM's and make sure everything worked properly.
139+
Let's try sending a private message to the author of a message. Select the message you sent to the [#test here](https://chat.zulip.org/#narrow/stream/7-test-here) stream earlier and press <kbd>shift</kbd><kbd>r</kbd> to send a private message to yourself. Type your message in the message editor that appears at the bottom of the middle column and then type <kbd>ctrl</kbd><kbd>d</kbd> to send. Press the <kbd>shift</kbd><kbd>p</kbd> hotkey as we did earlier in the tutorial to narrow to your private messages and make sure everything worked properly.
140140

141141
<img src="getting-started-imgs/send-pm.png" width="85%">
142142

143143
### Send a Private Message to Someone New
144144

145-
You can send a PM by moving your cursor to the list of "Users" in the right column and selecting the name of the person you'd like to send a message to.
145+
You can send a private message by moving your cursor to the list of "Users" in the right column and selecting the name of the person you'd like to send a message to.
146146

147147
From version 0.7.0 you can also use autocomplete to enter people's names from partial information, and easily send one-to-one or group private messages!
148148

149-
To send a PM using the autocomplete feature:
149+
To send a private message using the autocomplete feature:
150150
1. Use the <kbd>x</kbd> hotkey. A message editor will pop open at the bottom of the middle column.
151-
2. Type in part of the name of the person you'd like to send a PM to (IMG 1)
151+
2. Type in part of the name of the person you'd like to send a private message to (IMG 1)
152152
3. Press <kbd>ctrl</kbd><kbd>f</kbd> and a list of potential recipients will appear in the footer (highlighted in red).
153153
4. Press <kbd>ctrl</kbd><kbd>f</kbd> until the name of the person you want to send a message to is highlighted (IMG 2).
154154
5. Press <kbd>tab</kbd> to jump to the message section and type in your message.

zulipterminal/ui_tools/buttons.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
UI buttons for 'narrowing' and showing unread counts, such as Stream, PM, Topic, Home, Starred, etc
2+
UI buttons for 'narrowing' & showing unread counts, eg. All, Stream, Private message, Topic, Starred
33
"""
44

55
import re

0 commit comments

Comments
 (0)