Skip to content

Commit

Permalink
docs/keys/buttons: Rename 'private' to 'direct' in docs.
Browse files Browse the repository at this point in the history
This commit replaces the use of 'private' with 'direct' in the docs.
It also edits the buttons.py docstring to pass the linter.
Fixes part of #1288.
  • Loading branch information
theViz343 committed Mar 12, 2023
1 parent 47a7389 commit e0ed0dd
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 19 deletions.
6 changes: 3 additions & 3 deletions docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ In the longer term we may move to multiple servers per session, which is tracked
## What is autocomplete? Why is it useful?

Autocomplete can be used to request matching options, and cycle through each option in turn, including:
- helping to specify users for new private messages (eg. after <kbd>x</kbd>)
- helping to specify users for new direct messages (eg. after <kbd>x</kbd>)
- helping to specify streams and existing topics for new stream messages (eg. after <kbd>c</kbd>)
- mentioning a user or user-group (in message content)
- linking to a stream or existing topic (in message content)
Expand Down Expand Up @@ -192,7 +192,7 @@ As in the example above, a specific prefix is required to indicate which action

### Autocomplete of message recipients

Since each of the stream (1), topic (2) and private message recipients (3) areas are very specific, no prefix must be manually entered and values provided through autocomplete depend upon the context automatically.
Since each of the stream (1), topic (2) and direct message recipients (3) areas are very specific, no prefix must be manually entered and values provided through autocomplete depend upon the context automatically.

![Stream header](https://user-images.githubusercontent.com/55916430/118403323-8e5b7580-b68b-11eb-9c8a-734c2fe6b774.png)

Expand All @@ -204,7 +204,7 @@ Since each of the stream (1), topic (2) and private message recipients (3) areas

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

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

## Unable to render symbols

Expand Down
4 changes: 2 additions & 2 deletions docs/developer-feature-tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ You can view these events in the `type` file in your `zulip-terminal` home direc

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

If all the above conditions are satisfied we can successfully update the footer to display `X is typing` until we receive
a `stop` event for typing.
Expand Down
2 changes: 1 addition & 1 deletion docs/developer-file-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Zulip Terminal uses [Zulip's API](https://zulip.com/api/) to store and retrieve
| | ui_sizes.py | Fixed sizes of UI elements |
| | | |
| zulipterminal/ui_tools | boxes.py | UI boxes for entering text: WriteBox, MessageSearchBox, PanelSearchBox |
| | buttons.py | UI buttons for narrowing & showing unread counts, eg. All, Stream, Private, Topic |
| | buttons.py | UI buttons for narrowing & showing unread counts, eg. All, Stream, Direct, Topic |
| | messages.py | UI to render a Zulip message for display, and respond contextually to actions |
| | tables.py | Helper functions which render tables in the UI |
| | utils.py | The `MessageBox` for every message displayed is created here |
Expand Down
24 changes: 12 additions & 12 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ This tutorial was designed to be interactive. We highly recommend opening up Zul
+ [Narrow to the Stream or Topic of a Message](#Narrow-to-the-Stream-or-Topic-of-a-Message)
6. [Sending Messages](#Sending-Messages)
+ [Reply to a Message](#Reply-to-a-Message)
+ [Reply via a Private Message](#Reply-via-a-Private-Message)
+ [Send a Private Message to Someone New](#Send-a-Private-Message-to-Someone-New)
+ [Reply via a Direct Message](#Reply-via-a-Direct-Message)
+ [Send a Direct Message to Someone New](#Send-a-Direct-Message-to-Someone-New)
+ [Create a New Topic](#Create-a-New-Topic)
7. [Edit a Message](#Edit-a-Message)
8. [Close Zulip Terminal](#Close-Zulip-Terminal)
Expand Down Expand Up @@ -63,7 +63,7 @@ Sometimes it can take forever to manually move our cursor where we want it - tha

Let's try out a few of these shortcuts!

+ First, type <kbd>shift</kbd><kbd>p</kbd> to view your **Private Messages** (PMs).
+ First, type <kbd>shift</kbd><kbd>p</kbd> to view your **Direct Messages** (DMs).

+ Second, type <kbd>#</kbd> to view all messages you were mentioned (@'ed) in.

Expand All @@ -77,7 +77,7 @@ Let's try out a few of these shortcuts!
You'll be hearing the term 'narrow' a lot in Zulip. What does it mean?

+ **Noun**: A narrow is a set of filters for Zulip messages, that can be based on many different factors (like sender, stream, topic, search keywords, etc.).
+ **Verb**: The process of navigating to a different narrow. For example, to go from viewing a stream to a topic within that stream. There are several different ways to 'narrow to a narrow' so to speak. For example, you can use the keyboard shortcuts as we did in the section above. When you used the keyboard shortcut <kbd>shift</kbd><kbd>p</kbd> to view your private messages (PMs), you 'narrowed' to the **Private Messages** narrow.
+ **Verb**: The process of navigating to a different narrow. For example, to go from viewing a stream to a topic within that stream. There are several different ways to 'narrow to a narrow' so to speak. For example, you can use the keyboard shortcuts as we did in the section above. When you used the keyboard shortcut <kbd>shift</kbd><kbd>p</kbd> to view your direct messages (PMs), you 'narrowed' to the **Direct Messages** narrow.

### Your Current Narrow

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

### Reply to a Message

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).
To reply to an existing stream- or direct-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).

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

Expand All @@ -134,21 +134,21 @@ If you want to show you agree with the current message, type <kbd>+</kbd> to add

<img src="getting-started-imgs/thumbs-up.png" width="85%">

### Reply via a Private Message
### Reply via a Direct Message

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.
Let's try sending a direct 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 direct 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 direct messages and make sure everything worked properly.

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

### Send a Private Message to Someone New
### Send a Direct Message to Someone New

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.
You can send a direct 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.

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!
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 direct messages!

To send a private message using the autocomplete feature:
To send a direct message using the autocomplete feature:
1. Use the <kbd>x</kbd> hotkey. A message editor will pop open at the bottom of the middle column.
2. Type in part of the name of the person you'd like to send a private message to (IMG 1)
2. Type in part of the name of the person you'd like to send a direct message to (IMG 1)
3. Press <kbd>ctrl</kbd><kbd>f</kbd> and a list of potential recipients will appear in the footer (highlighted in red).
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).
5. Press <kbd>tab</kbd> to jump to the message section and type in your message.
Expand Down
2 changes: 1 addition & 1 deletion zulipterminal/ui_tools/buttons.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
UI buttons for narrowing & showing unread counts, eg. All, Stream, Private, Topic
UI buttons for narrowing & showing unread counts, eg. All, Stream, Direct, Topic
"""

import re
Expand Down

0 comments on commit e0ed0dd

Please sign in to comment.