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

Doc links #280

Closed
o0Ignition0o opened this issue Oct 11, 2020 · 6 comments · Fixed by #310
Closed

Doc links #280

o0Ignition0o opened this issue Oct 11, 2020 · 6 comments · Fixed by #310
Assignees

Comments

@o0Ignition0o
Copy link
Contributor

Quite a bit of doc links are out of date, refering to the old location of files. this calls for a pass to check what happened and what is where now

  • Version:
  • Platform:
  • Subsystem:
@scrabsha
Copy link
Contributor

I'll work on this one! Additionally, I'll migrate every link I find to the new intra-doc-link.

@o0Ignition0o
Copy link
Contributor Author

That's amazing, thanks for doing this! 🎉

@scrabsha
Copy link
Contributor

scrabsha commented Feb 24, 2021

I have nearly fixed everything.

I'm wondering what should be done here: should we redirect to RefAddr or to Answer?

@o0Ignition0o
Copy link
Contributor Author

Haha good question 😂

I would point to RefAddr, and I think we can rework the docs later, to add more intent as to what we mean by "signature, sender, receiver" etc.

But I guess this will make more sense once #309 lands :D

@scrabsha
Copy link
Contributor

One last question:
The documentation for BastionContext has a link entitled exec. I searched across the codebase, but found no function with that name. What am I missing?

@o0Ignition0o
Copy link
Contributor Author

Entitled links, I hate them :p

i think it refers to a child’s with exec closure,that is executed on each spawn:
https://github.com/bastion-rs/bastion/blob/master/src/bastion/src/child.rs#L423

https://github.com/bastion-rs/bastion/blob/master/src/bastion/src/children.rs#L306

Maybe ?

sorry I’m on the phone I can’t format it better :/

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 a pull request may close this issue.

2 participants