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

FAQ: Mention Windows Terminal text rendering issues. #955

Closed
wants to merge 1 commit into from

Conversation

prah23
Copy link
Member

@prah23 prah23 commented Mar 20, 2021

This PR adds a commit updating the FAQ with the observed Windows Terminal issue regarding rendering bold and normal text the same way.

@zulipbot zulipbot added the size: XS [Automatic label added by zulipbot] label Mar 20, 2021
@prah23 prah23 force-pushed the docs_update_windows_info branch 2 times, most recently from 5664e09 to 753c1de Compare March 21, 2021 16:04
@neiljp neiljp added the PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback label Mar 24, 2021
@prah23
Copy link
Member Author

prah23 commented Mar 24, 2021

@zulipbot add "PR needs review"
@zulipbot remove "PR awaiting update"

@zulipbot zulipbot added PR needs review PR requires feedback to proceed and removed PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback labels Mar 24, 2021
@prah23
Copy link
Member Author

prah23 commented Mar 24, 2021

@neiljp I think we'd benefit from a minor issues section apart from the issues section we already have, because the successful emulators section and the current issues section seem to be disjoint sets. We're bound to notice more minor issues on other emulators which aren't necessarily serious enough that we consider them unsuccessful. What are your thoughts on this?

@prah23 prah23 force-pushed the docs_update_windows_info branch from 753c1de to eb79f05 Compare March 24, 2021 15:43
@prah23
Copy link
Member Author

prah23 commented Mar 24, 2021

I've updated it to mention issues as a sub-point. Would this be a better pattern to follow?

@neiljp
Copy link
Collaborator

neiljp commented Mar 24, 2021

The sub-point seems to distract from the list flow?

Right now two ideas come to mind:

  • place all "perfect" emulators in the top list, clarify that the bottom list have issues but in each one state major/minor
  • place all emulators in a "tested" list, with listed caveats against some below (ie. an "issues" list underneath)

I'm inclined towards the first of these since it keeps it cleaner and requires only an update to the text of the lower list.

ZT is not unusable on Mac Terminal, it can be worked around - we could note how - so I'm not sure this is so different.

@neiljp neiljp added PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback and removed PR needs review PR requires feedback to proceed labels Mar 24, 2021
This commit updates the FAQ with the observed Windows Terminal issue
regarding rendering bold and normal text the same way. This commit
also specifies issue severity (major/minor) for each "imperfect"
terminal emulator.
@prah23 prah23 force-pushed the docs_update_windows_info branch from eb79f05 to cf96b91 Compare March 24, 2021 21:11
@prah23
Copy link
Member Author

prah23 commented Mar 24, 2021

With the Mac Terminal, I meant the issue was more severe comparatively because it needed the user to change his keybindings, or change keys.py. Your suggestion was clearer than the previous iteration nonetheless, and I've updated it.

@zulipbot add "PR needs review"
@zulipbot remove "PR awaiting update"

@zulipbot zulipbot added PR needs review PR requires feedback to proceed and removed PR awaiting update PR has been reviewed & is awaiting update or response to reviewer feedback labels Mar 24, 2021
@zulipbot
Copy link
Member

Heads up @prah23, we just merged some commits that conflict with the changes your made in this pull request! You can review this repository's recent commits to see where the conflicts occur. Please rebase your feature branch against the upstream/main branch and resolve your pull request's merge conflicts accordingly.

@neiljp
Copy link
Collaborator

neiljp commented Mar 25, 2021

@prah23 Thanks for the documentation update - merged with minor update as fbe6973 for consistency 🎉

@neiljp neiljp closed this Mar 25, 2021
@neiljp neiljp added this to the Next Release milestone Mar 25, 2021
@neiljp neiljp added area: documentation Requires changes in documentation and removed has conflicts PR needs review PR requires feedback to proceed labels Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Requires changes in documentation size: XS [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants