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.

Sign up for GitHub

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

Jump to bottom

Edit the breaking change doc for publishing on docs #60260

Merged
merged 5 commits into from
Mar 21, 2022
Merged

Edit the breaking change doc for publishing on docs #60260

merged 5 commits into from
Mar 21, 2022

Conversation

BillWagner
Copy link
Member

Update the breaking changes doc in the following ways to bring it inline with the information we're publishing on docs. (That way, instead of replicating the information, we'll publish this document instead).

  1. Start the article with an H1.
  2. Create H2s for each breaking change. The H2s should contain keywords for developers who have been impacted by the change.
  3. Order the breaking changes from most recent to oldest (effectively reversing the order)
  4. Clearly identify the version introduced.
  5. Add a brief reason for the change. Link to LDM notes or proposals for more details.
  6. Add information about workarounds.

@BillWagner BillWagner requested a review from a team as a code owner March 18, 2022 17:50
BillWagner
BillWagner commented Mar 18, 2022
View reviewed changes
docs/compilers/CSharp/Compiler Breaking Changes - DotNet 7.md

This change fixes a spec violation where the public `DisposeAsync` method is visible on the declared type, whereas the explicit interface implementation is only visible using a reference to the interface type.

To workaround this error, remove the pattern based `DisposeAsync` method from your type.
Copy link
Member Author

Choose a reason for hiding this comment

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

This change isn't yet available in the preview I'm running. I'll verify once the next internal preview is available, or you can verify.

@BillWagner
Copy link
Member Author

ping @jcouv @KathleenDollard per internal discussion

@jcouv jcouv self-assigned this Mar 18, 2022
RikkiGibson
RikkiGibson reviewed Mar 18, 2022
View reviewed changes
Copy link
Contributor

@RikkiGibson RikkiGibson left a comment

Choose a reason for hiding this comment

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

It might be useful for reviewing to have a commit that only changes the order, and then another commit which changes the content.

@BillWagner
Copy link
Member Author

It might be useful for reviewing to have a commit that only changes the order, and then another commit which changes the content.

I wish I'd have thought of that earlier. I'll see what I can do to fix history.

@RikkiGibson
Copy link
Contributor

The following steps might do the trick:

  1. make a new local branch off of edit-breaking-changes, e.g. git branch edit-breaking-changes-2. Don't check out the new branch.
  2. git reset --hard to the parent commit 044254c
  3. do the edits to reverse the order of entries in the original doc, then commit
  4. git checkout edit-breaking-changes-2 -- "docs/compilers/CSharp/Compiler Breaking Changes - DotNet 7.md" to use the content of the file as it is in this PR
  5. commit that and force push to edit-breaking-changes
  6. profit!

@BillWagner
Copy link
Member Author

I did pretty much what @RikkiGibson had suggested. The only difference is that the first commit also changes the opening H2 to an H1. Otherwise, the diffs in the 2nd commit were pretty pointless.

BillWagner and others added 2 commits March 18, 2022 15:24
@BillWagner @RikkiGibson
Update docs/compilers/CSharp/Compiler Breaking Changes - DotNet 7.md
6844408 
Co-authored-by: Rikki Gibson <rikkigibson@gmail.com>
@BillWagner
remove extra period.
cc1bb92 
Missed with the bold italic styling.
jcouv
jcouv approved these changes Mar 21, 2022
View reviewed changes
Copy link
Member

@jcouv jcouv left a comment

Choose a reason for hiding this comment

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

LGTM Thanks (iteration 5)

@jcouv jcouv merged commit 6cb4996 into dotnet:main Mar 21, 2022
@ghost ghost added this to the Next milestone Mar 21, 2022
@BillWagner BillWagner deleted the edit-breaking-changes branch March 24, 2022 15:01
@333fred 333fred mentioned this pull request Mar 24, 2022
Merged
333fred added a commit to 333fred/roslyn that referenced this pull request Mar 24, 2022
@333fred
Merge remote-tracking branch 'upstream/main' into merge-main-to-requi…
f7be5de 
…red-members

* upstream/main: (50 commits)
  Fix top-level speculation (dotnet#60274)
  Skip CodeDefinitionWindows integration tests
  Avoid resizing array builder while get unaliased references (dotnet#60220)
  Fix our x86 test execution (dotnet#60323)
  [LSP] Don't adjust breakpoints when there are diagnostics in the document (dotnet#60334)
  Allow VS Mac to access a few options and a helper method (dotnet#60333)
  Add support for CheckedStatement for smart break line (dotnet#60308)
  Initialize MEF parts before switching to the UI thread (dotnet#60289)
  Don't offer convert to switch when an implicit cast is present (dotnet#60224)
  Fix
  Add basic TS LSP server (dotnet#59639)
  Fix issue when multiple different diagnostics share a single fixer
  Update dependencies from https://github.com/dotnet/arcade build 20220321.2 (dotnet#60315)
  Check for reference assembly before deciding which language to show (dotnet#60271)
  Fix XLF files that were manually edited
  Revert "Fix a typo and an inconsistency"
  Fix conversion issues in null coalescing operator (dotnet#60202)
  Fix type parameter scoping for local functions (dotnet#60098)
  Update SDK version in docs, etc. (dotnet#60299)
  Edit the breaking change doc for publishing on docs (dotnet#60260)
  ...
333fred added a commit that referenced this pull request Mar 25, 2022
@333fred @sharwell
@genlu @jmarolf @danielchalmers @astroC86 @davidwengier @CyrusNajmabadi @Cosifne @BillWagner @RikkiGibson @jcouv @Youssef1313 @dotnet-maestro @JoeRobich @dibarbet @jaredpar @davkean
Merge main to features/required-members (#60373)
4804991 
* Create solution on the main thread in integration tests

* Close solution on the main thread in integration tests

* Use cached data for completion of unimported types

Even if it might be stale. the completion list would be computed with cached data and cache refresh would be done in background.

* Use cached data for completion of unimported extension methods

Even if it might be stale. the completion list would be computed with cached data and cache refresh would be done in background.

* Try to refresh import completion cache in the background whenever completion is triggered

* Use AsyncBatchingWorkQueue for background cache updates

* Fix tests

* clean up

* Fix tests

* Make sure background task to update cache always run

* Expose ForceExpandedCompletionIndexCreation option to O#

This can be used to tweak test behavior to make it deterministic

* Don't use Workspace.CurrentSolution when refreshing cache in background

* Use AsynchronousOperationListener for background workqueues

* Update src/Tools/ExternalAccess/OmniSharp/Completion/OmniSharpCompletionOptions.cs

Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>

* Pass ThreadingContext.DisposalToken to workqueue for cache refresh

* Remove namespace imports

* Remove enableRoslynAnalyzers from codespace default settings

Follow up to #60165

We don't think this is the right default as users probably don't want this unless they have at least 8 cores.

* Fix typo in Apply_namespace_matches_folder_preferences

* Remove period at the end to be consistent with other messages

* Fix inconsistency in other languages too

* Refactoring

* Ban incompatible service provider extension methods

* Assert window title before closing

* Remove outdated comment (#60275)

* Don't block on clearing the output window on the UI thread when generating a file (#60281)

* Fix issue with remove-unnecessary-cast and necessary explicit casts.

* Fix work item

* Correct change ObjectCreationExpression to ImplictObjectCreationExpression for SmartBreakline (#60249)

* Fix the initializer adding scenario

* Fix the initializer removal scenario

* Add an Assertion in debug to help if future derive type is added

* Remove the check for NewKeyword

* Option to always use default symbol servers for GTD (#60053)

* pass the listener to the constructor

* Edit the breaking change doc for publishing on docs (#60260)

Co-authored-by: Rikki Gibson <rikkigibson@gmail.com>

* Update SDK version in docs, etc. (#60299)

* Fix type parameter scoping for local functions (#60098)

Co-authored-by: Youssef1313 <youssefvictor00@gmail.com>

* Fix conversion issues in null coalescing operator (#60202)

* Revert "Fix a typo and an inconsistency"

This reverts #60238

* Fix XLF files that were manually edited

* Check for reference assembly before deciding which language to show (#60271)

* Update dependencies from https://github.com/dotnet/arcade build 20220321.2 (#60315)

[main] Update dependencies from dotnet/arcade

* Fix issue when multiple different diagnostics share a single fixer

* Add basic TS LSP server (#59639)

* Add basic TS LSP server

* Add external access layer for TS

* Include text sync handlers

* Fix build error

* Switch to explicit interface impl

* Fix namespaces

* Remove testing string

* Fix

* Don't offer convert to switch when an implicit cast is present (#60224)

* Initialize MEF parts before switching to the UI thread (#60289)

* Add support for CheckedStatement for smart break line (#60308)

* Add support for CheckedStatement

* Address feedback

* Remove a not needed import

* Allow VS Mac to access a few options and a helper method (#60333)

* [LSP] Don't adjust breakpoints when there are diagnostics in the document (#60334)

* Fix our x86 test execution (#60323)

* Fix our x86 test execution

The transition to `dotnet test` seems to have broken our unit tests that
depend on executing on an x86 architecture. This fixes that by using the
`--arch` argument to the `dotnet test` execution.

This was made more general to facilitate our future arm64 work in this
area

* Disable test failing on x64

* fix the test

* Apply suggestions from code review

Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>

* Disable test on spanish

* Test fixes

Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>

* Avoid resizing array builder while get unaliased references (#60220)

This was being resized constantly after opening Orchard Core, allocating about 2 GB. The fact that is being called this many times appears to be another bug that I'm following up on.

* Skip CodeDefinitionWindows integration tests

* Fix top-level speculation (#60274)

Co-authored-by: Youssef Victor <youssefvictor00@gmail.com>

Co-authored-by: Sam Harwell <Sam.Harwell@microsoft.com>
Co-authored-by: gel@microsoft.com <gel@microsoft.com>
Co-authored-by: Gen Lu <genlu@users.noreply.github.com>
Co-authored-by: Sam Harwell <sam@tunnelvisionlabs.com>
Co-authored-by: Jonathon Marolf <jmarolf@users.noreply.github.com>
Co-authored-by: Daniel Chalmers <daniel.chalmers@outlook.com>
Co-authored-by: astroC86 <66444189+astroC86@users.noreply.github.com>
Co-authored-by: David Wengier <david.wengier@microsoft.com>
Co-authored-by: Cyrus Najmabadi <cyrusn@microsoft.com>
Co-authored-by: Shen Chen <Cosifne@users.noreply.github.com>
Co-authored-by: CyrusNajmabadi <cyrus.najmabadi@gmail.com>
Co-authored-by: msftbot[bot] <48340428+msftbot[bot]@users.noreply.github.com>
Co-authored-by: Bill Wagner <wiwagn@microsoft.com>
Co-authored-by: Rikki Gibson <rikkigibson@gmail.com>
Co-authored-by: Rikki Gibson <rigibson@microsoft.com>
Co-authored-by: Julien Couvreur <jcouv@users.noreply.github.com>
Co-authored-by: Youssef1313 <youssefvictor00@gmail.com>
Co-authored-by: dotnet-maestro[bot] <42748379+dotnet-maestro[bot]@users.noreply.github.com>
Co-authored-by: Joey Robichaud <jorobich@microsoft.com>
Co-authored-by: David Barbet <dabarbet@microsoft.com>
Co-authored-by: Jared Parsons <jaredpparsons@gmail.com>
Co-authored-by: David Kean <davkean@microsoft.com>
@allisonchou allisonchou modified the milestones: Next, 17.2.P3 Mar 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cston cston cston left review comments

@Youssef1313 Youssef1313 Youssef1313 left review comments

@RikkiGibson RikkiGibson RikkiGibson approved these changes

@jcouv jcouv jcouv approved these changes

Assignees

@jcouv jcouv

Labels
Area-Compilers Documentation
Projects
None yet
Milestone
17.2.P3
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@BillWagner @RikkiGibson @cston @jcouv @Youssef1313 @allisonchou