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

Fix formatting of code snippets on iOS dev pages #11021

Merged
merged 45 commits into from
Sep 9, 2024

Conversation

piedcipher
Copy link
Member

@piedcipher piedcipher commented Aug 7, 2024

Fix Formatting.

Fixes #10725

Presubmit checklist

  • This PR is marked as draft with an explanation if not meant to land until a future stable release.
  • This PR doesn’t contain automatically generated corrections (Grammarly or similar).
  • This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn’t use i.e. or e.g., and it avoids I and we (first person).
  • This PR uses semantic line breaks of 80 characters or fewer.

@flutter-website-bot
Copy link
Collaborator

flutter-website-bot commented Aug 7, 2024

Visit the preview URL for this PR (updated for commit 8572493):

https://flutter-docs-prod--pr11021-fix-10725-yh3wme43.web.app

Copy link
Member

@parlough parlough 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 thinking about improving this!

For some reason it's not triggering, but CI is supposed to include a formatting check against these files with dart format. Running dart format will revert many of these changes. I'll work on fixing that check. (Edit: #11027)

What do you think about instead moving the docregion comments above the previous line (like child: ...)? It will end up showing some extra information, but I think that's okay considering the examples. We can remove those properties with other code excerpt functionality if needed as well.

@sfshaza2
Copy link
Contributor

I dare not insert myself here. When you are back, @parlough, can you address this one?

@sfshaza2
Copy link
Contributor

/gcbrun

Copy link
Contributor

@sfshaza2 sfshaza2 left a comment

Choose a reason for hiding this comment

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

If it lgt @domesticmouse, it looks good to me.

@piedcipher
Copy link
Member Author

piedcipher commented Sep 9, 2024

Thanks for thinking about improving this!

For some reason it's not triggering, but CI is supposed to include a formatting check against these files with dart format. Running dart format will revert many of these changes. I'll work on fixing that check. (Edit: #11027)

What do you think about instead moving the docregion comments above the previous line (like child: ...)? It will end up showing some extra information, but I think that's okay considering the examples. We can remove those properties with other code excerpt functionality if needed as well.

hey sry, i missed this. when i tried to run some excerpter generation command locally i got an error. that's what i remember last.

@parlough parlough requested a review from a team as a code owner September 9, 2024 20:26
@parlough parlough requested a review from RedBrogdon September 9, 2024 20:26
Copy link
Member

@parlough parlough left a comment

Choose a reason for hiding this comment

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

hey sry, i missed this. when i tried to run some excerpter generation command locally i got an error. that's what i remember last.

No worries! I went ahead and moved the comments and added replacement instructions for the code excerpt tool. You can check out the commit 9346457 to see what I did.

As for the error, let me know if you hit it again and I'd be happy to fix it or work through a solution with you.

Thanks again for doing this!!

@parlough parlough changed the title [Fix] Formatting Fix formatting of code snippets on iOS dev pages Sep 9, 2024
@parlough parlough merged commit 556b7a9 into flutter:main Sep 9, 2024
9 checks passed
@piedcipher piedcipher deleted the fix/10725 branch September 10, 2024 16:26
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.

Fix alignment on Dart snippets on first lines of "Flutter for SwiftUI Developers" page
5 participants