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

document engine-p porting #3868

Merged
merged 2 commits into from Aug 7, 2021
Merged

document engine-p porting #3868

merged 2 commits into from Aug 7, 2021

Conversation

ghost
Copy link

@ghost ghost commented Jul 30, 2021

See #3390 for all the details.

See #3390 for all the details.
@ghost
Copy link
Author

ghost commented Jul 30, 2021

@stormasm 👋 you may find this interesting. The how to guide steps have been floating around my head for a few months so I figured to write them out since we have enough left to warrant interim documentation.

@fdncred
Copy link
Collaborator

fdncred commented Jul 30, 2021

It looks like a 1 step process. You start on point 1, then go to the next point 1, then to the next point 1. LOL

@ghost
Copy link
Author

ghost commented Jul 30, 2021

It looks like a 1 step process. You start on point 1, then go to the next point 1, then to the next point 1. LOL

ha! definitely my local markdown editing confusing it! i'll revise.

@stormasm
Copy link
Contributor

@efx thanks for writing that up ---- looks good to me...

In many cases this is changing the function name and signature.
The function name goes from `run_with_actions` to `run`.
The signature goes from `Result<ActionStream, ShellError>`
to `Result<OutputStream, ShellError>`.
Copy link
Contributor

Choose a reason for hiding this comment

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

You might want to call out when you wouldn't be able to updated to OutputStream, eg when there are Actions that might also be part of the output.

Copy link
Author

Choose a reason for hiding this comment

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

@jntrnr good point. Could you share an example PR or link to a source file of what you were thinking of? I'm having trouble finding or coming up with an example of this.

Copy link
Contributor

Choose a reason for hiding this comment

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

@efx - One example is a command like open couldn't be converted because it can output an Action that will convert the data from one form to another.

@sophiajt
Copy link
Contributor

sophiajt commented Aug 7, 2021

Looks good!

@sophiajt sophiajt merged commit de71cbd into nushell:main Aug 7, 2021
@ghost ghost deleted the docs-engine-p-how-to branch August 9, 2021 12:55
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.

3 participants