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

Generated migration guide would benefit from automated cleanup #1195

Open
alice-i-cecile opened this issue May 23, 2024 · 1 comment
Open
Labels
A-Migration Guides C-Automation Tools to make repetitive tasks easier C-Feature A new feature, making something new possible

Comments

@alice-i-cecile
Copy link
Member

Bit of a nit, but I'm not a fan of all the white space inconsistency in the migration guide. How easy would it be to call str::trim on the file contents, then write an extra \n?

Originally posted by @BD103 in #1191 (comment)

Btw, the first thing I did pretty much every release was capitalize every title correctly and standardize all the before/after code blocks to use // bevy 0.13 / // bevy 0.14 people use a bunch of different ways to do that but it's pretty easy to just do a search and replace. Although now you'll need to do a search replace in the folder I guess

@alice-i-cecile alice-i-cecile added C-Feature A new feature, making something new possible A-Build-System A-Migration Guides labels May 23, 2024
@alice-i-cecile
Copy link
Member Author

We should be able to do a basic formatting pass on the contents of the migration guide before generating them :)

Release notes don't need this step: the starting content needs to be completely rewritten anyways.

@alice-i-cecile alice-i-cecile changed the title Generated migration guide is inconsistent Generated migration guide would benefit from automated cleanup May 30, 2024
@alice-i-cecile alice-i-cecile added C-Automation Tools to make repetitive tasks easier and removed A-Build-System labels Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Migration Guides C-Automation Tools to make repetitive tasks easier C-Feature A new feature, making something new possible
Projects
None yet
Development

No branches or pull requests

1 participant