search

bastion-rs / bastion

Highly-available Distributed Fault-tolerant Runtime
https://www.bastion-rs.com
Apache License 2.0
2.79k stars 103 forks source link

Doc links #280

Closed o0Ignition0o closed 3 years ago

o0Ignition0o commented 3 years ago

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

scrabsha commented 3 years ago

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

o0Ignition0o commented 3 years ago

That's amazing, thanks for doing this! 🎉

scrabsha commented 3 years ago

I have nearly fixed everything.

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

o0Ignition0o commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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 :/