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

Expanded flutter pub build section #3532

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

CadMunkey
Copy link
Contributor

@CadMunkey CadMunkey commented May 8, 2024

This important code is lost in the page. Expanded with note and a tip of how to generate code on ad-hoc basis

Related Issues

fixes #your-issue-number

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]).

  • I have updated the CHANGELOG.md of the relevant packages.
    Changelog files must be edited under the form:

    ## Unreleased fix/major/minor
    
    - Description of your change. (thanks to @yourGithubId)
  • If this contains new features or behavior changes,
    I have updated the documentation to match those changes.

This important code is lost in the page. Expanded with note and a tip of how to generate code on ad-hoc basis
Copy link

changeset-bot bot commented May 8, 2024

⚠️ No Changeset found

Latest commit: 438b42f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Comment on lines +82 to +86
:::tip
To generate code on an ad-hoc basis you can run the following:
```sh
flutter pub build_runner build --delete-conflicting-outputs
```
Copy link
Owner

Choose a reason for hiding this comment

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

I doubt that's a very useful information

@@ -72,8 +72,19 @@ Alternatively, you can manually add the dependency to your app from within your
Then, install packages with `flutter pub get`.

<When codegen={true}>
## Generating code from the terminal.
Copy link
Owner

Choose a reason for hiding this comment

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

Labels aren't supported by the doc inside conditional text.

@@ -72,8 +72,19 @@ Alternatively, you can manually add the dependency to your app from within your
Then, install packages with `flutter pub get`.

<When codegen={true}>
## Generating code from the terminal.
You can now run the code-generator with{" "}
<code>flutter pub run build_runner watch</code>.
Copy link
Owner

Choose a reason for hiding this comment

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

What about changing the <code> into a ```?

The label doesn't work, and I don't like the idea of adding semi-redundant information

Suggested change
<code>flutter pub run build_runner watch</code>.
Then, you'll need to start the code-generator. To do so, run the following command in a terminal:
```
flutter pub run build_runner watch</code>.
```

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.

None yet

2 participants