Git Product home page Git Product logo

Comments (4)

jamwaffles avatar jamwaffles commented on June 10, 2024 1

Hey, apologies for not having the best compatibility for that file. However, opening it again just now, it doesn't contain anything particularly useful. The exact content is these lines, posted here for posterity:

┌─────────────┐
│   Master    │
│     #0      │
│             │
└─────────────┘
       ▲
       ║
       ╚0▶┌────────────┐      ┌────────────┐      ┌────────────┐──┐
          │   EK1100   │      │   EL2004   │      │   EL3004   │  │
          │     #1     │◀3══0▶│     #3     │◀3══0▶│     #4     │  │
          │            │      │            │      │            │  │
       ╔1▶└────────────┘      └────────────┘      └────────────┘◀─┘
       ║
       ║  ┌────────────┐──┐
       ║  │  LAN9252   │  │
       ╚0▶│     #5     │  │
          │            │  │
          └────────────┘◀─┘

I'm going to remove the Monodraw source as it's not useful and clearly confusing :)

from ethercrab.

HolgerJeromin avatar HolgerJeromin commented on June 10, 2024

JFYI:
such diagrams can be made with
https://mermaid.js.org/
which can be included in markdown files and are live rendered in the github interface when viewing the doc.

from ethercrab.

jamwaffles avatar jamwaffles commented on June 10, 2024

Indeed :). I'm using Mermaid for some of the internal doc comments. Even though docs.rs won't render them (yet?), they can still be pasted into a Mermaid renderer.

from ethercrab.

HolgerJeromin avatar HolgerJeromin commented on June 10, 2024

Hmm, extracting the mermaid code from mod.rs in a sibling mod.md feels ugly...
But this is soo nice :-)

flowchart TD
   FrameState::None -->|"alloc_frame()\nFrame is now exclusively (guaranteed by atomic state) available to calling code"| FrameState::Created
   FrameState::Created -->|populate PDU command, data| FrameState::Created
   FrameState::Created -->|"frame.mark_sendable()\nTHEN\nWake TX loop"| FrameState::Sendable
   FrameState::Sendable -->|TX loop sends over network| FrameState::Sending
   FrameState::Sending -->|"RX loop receives frame, calls pdu_rx()\nClaims frame as receiving"| FrameState::RxBusy
   FrameState::RxBusy -->|"Validation/processing complete\nReceivingFrame::mark_received()\nWake frame waker"| FrameState::RxDone
   FrameState::RxDone -->|"Wake future\nCalling code can now use response data"| FrameState::RxProcessing
   FrameState::RxProcessing -->|"Calling code is done with frame\nReceivedFrame::drop()"| FrameState::None

from ethercrab.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.