Skip to content

Release highlights and change log review for 2022.1#13479

Merged
seanbudd merged 6 commits into
betafrom
changesFor2022.1
Mar 17, 2022
Merged

Release highlights and change log review for 2022.1#13479
seanbudd merged 6 commits into
betafrom
changesFor2022.1

Conversation

@seanbudd

@seanbudd seanbudd commented Mar 15, 2022

Copy link
Copy Markdown
Member

Add release highlights for the 2022.1 release.

(squash merge)

@seanbudd seanbudd requested a review from a team as a code owner March 15, 2022 03:03
@seanbudd seanbudd requested review from a team, Qchristensen, feerrenrut and michaelDCurran and removed request for a team March 15, 2022 03:03
@seanbudd seanbudd marked this pull request as draft March 15, 2022 04:30
Qchristensen
Qchristensen previously approved these changes Mar 15, 2022

@Qchristensen Qchristensen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good, great work!

@seanbudd seanbudd marked this pull request as ready for review March 15, 2022 05:04
Comment thread user_docs/en/changes.t2t Outdated
Comment thread user_docs/en/changes.t2t Outdated
@feerrenrut feerrenrut mentioned this pull request Mar 15, 2022
2 tasks
feerrenrut
feerrenrut previously approved these changes Mar 15, 2022
@seanbudd seanbudd added this to the 2022.1 milestone Mar 15, 2022
Comment thread user_docs/en/changes.t2t
- ``NVDA+Shift+Numpad Delete`` reports the location of the review cursor. (#13060)
- Added default bindings for toggling modifier keys to Freedom Scientific displays (#13152)
- 'Baseline' is no longer reported via the report text formatting command (NVDA+F). (#11815)
- "Baseline" is no longer reported via the report text formatting command (``NVDA+f``). (#11815)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NVDA+F shortcut styling has been modified here:

  • Code styling (fixed width) is used (adding double backquotes around the expression)
  • The F has been switched from uppercase to lowercase.
    Is it general styling recommendations to write documentation? Or is it just a matter of personal preference?

I have no strong reason to advocate for one styling or the other, but it's just to know if I need to change something in the future when writing documentation.

Thanks.

@seanbudd seanbudd Mar 17, 2022

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code styling (fixed width) is used (adding double backquotes around the expression)

I think we are trying to do this consistently now.
If this formatting is missing from other entries for this release and future releases, we should try to update them.
I don't know if this convention has been documented anywhere - they are a bit of a developing standard.

The F has been switched from uppercase to lowercase.

When documenting keyboard commands, "f" is the key name by convention, "F" tends to imply "shift+f".

@CyrilleB79

This comment was marked as resolved.

Comment thread user_docs/en/changes.t2t Outdated
@seanbudd seanbudd dismissed stale reviews from feerrenrut and Qchristensen via a304d1e March 17, 2022 01:15
@seanbudd seanbudd self-assigned this Mar 17, 2022
@seanbudd

seanbudd commented Mar 17, 2022

Copy link
Copy Markdown
Member Author

I've reviewed the changes.html file generated, and everything looks good. I have one remaining issue with the changelog:

Should the "arrow" -> be replaced with "then, " in the following entry:

 ​  - MathType equations must also be manually converted to Office Math by selecting each and choosing Equation options -> Convert to Office Math in the context menu. 

If this isn't an issue, can this be merged in to beta?

@feerrenrut

Copy link
Copy Markdown
Contributor

Should the "arrow" -> be replaced with "then, " in the following entry:

Yes, some other ways to address this would be:

  • put the steps on separate lines as sub-points/bullets
  • use just a comma: manually converted to Office Math by selecting each, opening the context menu, choosing Equation options, Convert to Office Math.

@seanbudd

Copy link
Copy Markdown
Member Author
  • use just a comma: manually converted to Office Math by selecting each, opening the context menu, choosing Equation options, Convert to Office Math.

I'm going to use this option

@seanbudd seanbudd requested a review from feerrenrut March 17, 2022 04:23
@seanbudd seanbudd merged commit 1e336c7 into beta Mar 17, 2022
@seanbudd seanbudd deleted the changesFor2022.1 branch March 17, 2022 05:24
@josephsl

josephsl commented Oct 11, 2022 via email

Copy link
Copy Markdown
Contributor

@seanbudd

Copy link
Copy Markdown
Member Author

@josephsl 2022.1 was released a long time ago. We do not update the change log section of previous releases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants