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

Unclear diff / instructions on cleaning up removed actions #352

Open
ramblinjan opened this issue Dec 27, 2022 · 6 comments
Open

Unclear diff / instructions on cleaning up removed actions #352

ramblinjan opened this issue Dec 27, 2022 · 6 comments

Comments

@ramblinjan
Copy link

I briefly got a bit confused here

What the instructions expect me to do is copy the code blocks and replace the files, but the diff makes it look like I'm adding something:

image

@m-thompson-code
Copy link
Contributor

This might be another limitation of using what's built into the academy. The primary source of confusion to me appears to be that the code diffs don't show the "removed" code like how github does:

bitovi/angular-ngrx-chat@ngrx-init...create-actions#diff-ad52571f65ab26c64ac8d66b4cc7ab571dbadc8112ee3ee9db65dda4d565ab29L2

For example:

import { Actions, createEffect, ofType } from '@ngrx/effects';

changes to:

import { Action } from '@ngrx/effects';

but it's not clear that we're removing stuff being imported from @ngrx/effects.

@m-thompson-code
Copy link
Contributor

Maybe to lessen the confusion we can point out that we'll be cleaning up the imports between steps as things aren't being used anymore, and show the code diffs as two code blocks like I did my first comment to this issue thread

@justinbmeyer
Copy link
Member

I think there's a way to tell academy to show the removed stuff. If not, it's probably pretty easy to add.

@m-thompson-code
Copy link
Contributor

bitovi/[email protected]#diff-ad52571f65ab26c64ac8d66b4cc7ab571dbadc8112ee3ee9db65dda4d565ab29L2

That would be great, I can't find any examples in academy or in the bit-docs readme. ):

@m-thompson-code
Copy link
Contributor

For now I added copy to explain that we're cleaning up the imports for these files

@m-thompson-code
Copy link
Contributor

Added some more context on this step: #354

I don't know for sure if it's clear enough though, I'll try to get more eyes on this section so we can make it more clear

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

No branches or pull requests

3 participants