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

Docs: Improve autocomplete docs & expand PMs to Private Messages #1293

Merged
merged 5 commits into from
Feb 9, 2023

Conversation

neiljp
Copy link
Collaborator

@neiljp neiljp commented Feb 7, 2023

What does this PR do?

Primarily:

Tested?

  • Manually
  • Existing tests (adapted, if necessary)
  • New tests added (for any new behavior)
  • Passed linting & tests (each commit)

@neiljp neiljp added area: documentation Requires changes in documentation PR ready to be merged PR has been reviewed & is ready to be merged area: autocomplete labels Feb 7, 2023
@neiljp neiljp added this to the Next Release milestone Feb 7, 2023
@zulipbot zulipbot added the size: L [Automatic label added by zulipbot] label Feb 7, 2023
@neiljp neiljp force-pushed the 2023-01-18-autocomplete-FAQ-update branch from 370faf0 to eec831a Compare February 7, 2023 23:03
Summarize specific uses of autocomplete and why it is helpful.

Add note comparing autocomplete to stream/topic/user searches.
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 zulip#1288.
@neiljp neiljp merged commit 886291e into zulip:main Feb 9, 2023
theViz343 added a commit to theViz343/zulip-terminal that referenced this pull request Mar 17, 2023
This commit replaces the use of 'private' with 'direct' in the docs.
It also removes instances of PM (abbreviation for private message)
following the change in zulip#1293.

Fixed the large column width issue for developer-file-overview.md.
theViz343 added a commit to theViz343/zulip-terminal that referenced this pull request Mar 18, 2023
This commit replaces the use of 'private' with 'direct' in the docs.
It also removes instances of PM (abbreviation for private message)
following the change in zulip#1293.
neiljp pushed a commit to theViz343/zulip-terminal that referenced this pull request Mar 21, 2023
This commit replaces the use of 'private' with 'direct' in the docs.
It also removes instances of PM (abbreviation for private message)
following the change in zulip#1293.
neiljp pushed a commit that referenced this pull request Mar 21, 2023
This commit replaces the use of 'private' with 'direct' in the docs.
It also removes instances of PM (abbreviation for private message)
following the change in #1293.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: autocomplete area: documentation Requires changes in documentation PR ready to be merged PR has been reviewed & is ready to be merged size: L [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants