6d4a9ad01c
# Objective - I've worked on the migration guide in the past, so I've written down some of the conventions and styles I've used. ## Solution Please read through the descriptions of each commit, which justify the change! In summary: - Remove headings from migration guide template by moving style guide to `migration_guides.md` - Use parentheses to signal method and function names (`my_func()` instead of `my_func`) - Change the guidelines on using bullet points so they're not used for every single migration guide. - Remove suggestion to use diff blocks, as they don't syntax-highlight Rust code. --------- Co-authored-by: Rob Parrett <robparrett@gmail.com> Co-authored-by: Miles Silberling-Cook <NthTensor@users.noreply.github.com> Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com>
15 lines
463 B
Markdown
15 lines
463 B
Markdown
---
|
|
title: Feature that broke
|
|
pull_requests: [14791, 15458, 15269]
|
|
---
|
|
|
|
Copy the contents of this file into a new file in `./migration-guides`, update the metadata, and add migration guide content here.
|
|
|
|
Remember, your aim is to communicate:
|
|
|
|
- What has changed since the last release?
|
|
- Why did we make this breaking change?
|
|
- How can users migrate their existing code?
|
|
|
|
For more specifics about style and content, see the [instructions](./migration_guides.md).
|