Skip to content

Improvements to code examples #150

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

Merged
merged 4 commits into from
Apr 2, 2025
Merged

Conversation

HeinrichvonStein
Copy link

This PR introduces improvements to the code examples by

  • stating directory and file names
  • providing imports
  • adding additional context

Copy link
Contributor

@simolus3 simolus3 left a comment

Choose a reason for hiding this comment

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

This generally looks good to me 👍 Despite what I've said earlier offline, I think in this case it makes sense to consistently use relative imports though. The reason is that we don't know the package name the user wil choose for their app, and relative imports will "just work" as long as you put the snippets we suggest in the same folder.

Copy link
Contributor

@simolus3 simolus3 left a comment

Choose a reason for hiding this comment

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

Looks good to me now (apart from one minor nit) 👍

@HeinrichvonStein HeinrichvonStein merged commit b7b188d into docs Apr 2, 2025
3 checks passed
@HeinrichvonStein HeinrichvonStein deleted the feature/improve-ff-docs branch April 2, 2025 08:38
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.

2 participants