Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Say "DM" / "direct message" instead of "PM" / "private message", in code and UI #145

Closed
gnprice opened this issue Jun 1, 2023 · 2 comments · Fixed by #152
Closed

Say "DM" / "direct message" instead of "PM" / "private message", in code and UI #145

gnprice opened this issue Jun 1, 2023 · 2 comments · Fixed by #152
Assignees
Labels
a-api Implementing specific parts of the Zulip server API
Milestone

Comments

@gnprice
Copy link
Member

gnprice commented Jun 1, 2023

This is a change that happened in the web UI a few weeks after I started prototyping the Flutter app:

It's also happening in the server API, though necessarily more gradually. See summary at:

The code still reflects the old name, in identifiers and comments. We should update it to the new name; this is easier to do the sooner we do it.

While we're at it, we should handle occurrences in UI text, too. I think the only one of these so far is in recipient headers.

Out of scope for this issue is to use the new name in the actual API, in the places where it's accepted. That's tracked as part of:


To find places to update, use the following search:

$ git grep -P 'pm|Pm|PM|(?i:private)' -- lib test

That currently finds 43 lines, of which it looks like

  • 4 are in the API;
  • 4 are false positives;
  • so 35 are in scope for this issue.
@gnprice gnprice added this to the Alpha milestone Jun 1, 2023
@gnprice gnprice self-assigned this Jun 1, 2023
gnprice added a commit to gnprice/zulip-flutter that referenced this issue Jun 5, 2023
…d code

There was only one occurrence in the UI, in [DmRecipientHeader].

The remaining few places we refer to the old names are in the
context of the server API.  We have issue zulip#146 open to start using
the new names there where possible.

Fixes: zulip#145
gnprice added a commit to gnprice/zulip-flutter that referenced this issue Jun 5, 2023
…d code

There was only one occurrence in the UI, in [DmRecipientHeader].

The remaining few places we refer to the old names are in the
context of the server API.  We have issue zulip#146 open to start using
the new names there where possible.

Fixes: zulip#145
chrisbobbe pushed a commit that referenced this issue Jun 6, 2023
…d code

There was only one occurrence in the UI, in [DmRecipientHeader].

The remaining few places we refer to the old names are in the
context of the server API.  We have issue #146 open to start using
the new names there where possible.

Fixes: #145
@gnprice gnprice added the a-api Implementing specific parts of the Zulip server API label Jun 14, 2023
@PIG208
Copy link
Member

PIG208 commented Jul 1, 2024

/// As in [DeleteMessageEvent.messageType]
/// or [UpdateMessageFlagsMessageDetail.type].
@JsonEnum(fieldRename: FieldRename.snake)
enum MessageType {
stream,
private;
}

It appears that there are some additional instances of "private" for MessageType used in some event models. Should we reopen the issue?

@gnprice
Copy link
Member Author

gnprice commented Jul 2, 2024

Hmm indeed, thanks. Rerunning the search command above, there's also InitialSnapshot.recentPrivateConversations.

It looks like both that and MessageType.private were introduced after this issue was closed by #152.

I'll open a new issue for it — I think it'll be easier to track the revived issue that way, since this old one was fixed a year ago.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
a-api Implementing specific parts of the Zulip server API
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants