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

BinaryFormatter Migration Guide: Formatting, exception type, API links #42088

Conversation

jeffhandley
Copy link
Member

@jeffhandley jeffhandley commented Aug 9, 2024

For the BinaryFormatter Migration Guide:

  1. Specify the exception that is thrown (PlatformNotSupportedException)
  2. Change WinForms/WPF "applications" to "apps"
  3. Add spacing between bulleted lines on the MessagePack page (matching the System.Text.Json page's formatting to give space between each statement in the list)
  4. Add API docs links, especially to the NrbfDecoder APIs
  5. Fix broken links to the BinaryFormatter security guide

Internal previews

📄 File 🔗 Preview link
docs/standard/serialization/binaryformatter-migration-guide/choose-a-serializer.md docs/standard/serialization/binaryformatter-migration-guide/choose-a-serializer
docs/standard/serialization/binaryformatter-migration-guide/functionality-reference.md docs/standard/serialization/binaryformatter-migration-guide/functionality-reference
docs/standard/serialization/binaryformatter-migration-guide/index.md docs/standard/serialization/binaryformatter-migration-guide/index
docs/standard/serialization/binaryformatter-migration-guide/migrate-to-messagepack.md docs/standard/serialization/binaryformatter-migration-guide/migrate-to-messagepack
docs/standard/serialization/binaryformatter-migration-guide/read-nrbf-payloads.md docs/standard/serialization/binaryformatter-migration-guide/read-nrbf-payloads
docs/standard/serialization/binaryformatter-migration-guide/winforms-applications.md docs/standard/serialization/binaryformatter-migration-guide/winforms-applications
docs/standard/serialization/binaryformatter-migration-guide/winforms-wpf-ole-guidance.md docs/standard/serialization/binaryformatter-migration-guide/winforms-wpf-ole-guidance
docs/standard/serialization/binaryformatter-migration-guide/wpf-applications.md docs/standard/serialization/binaryformatter-migration-guide/wpf-applications

Copy link
Member

@terrajobst terrajobst left a comment

Choose a reason for hiding this comment

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

Thanks for fixing those, looks great!

@jeffhandley
Copy link
Member Author

OK -- the links to the binaryformatter-security-guide are finally correct. It required:

  1. Absolute link starting with /dotnet/standard/...
  2. Removing the .md file extension

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

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

This overall looks good.

I think it would be better to use the xref style links rather than the page links for API reference.

@terrajobst
Copy link
Member

@BillWagner I've replaced all use of links to API with xref.

@terrajobst terrajobst merged commit 502271e into dotnet:main Aug 12, 2024
8 checks passed
@jeffhandley jeffhandley deleted the jeffhandley/binaryformatter-migration-guide-edits branch August 19, 2024 20:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants