Skip to content

Doc enhancement proposal: real big hard examples #355

Description

@potens1

The lib documentation is huge and well written, but, I feel it miss big examples requiring interaction between lots of elements.

There are plenty of examples in the doc, but most of them are limited to only one thing without any interaction with something else. (and are obvious)

I feel (having tried to write three different parsers with the lib) there are a lot of "traps" and corner cases when elements are combined.

The chosen thing to parse should not be obvious and require some tricks to be able to parse (Rebuild, RawCopy and Seek, I'm looking at you !). It does not need to be a real protocol, can be made up especially to showcase what to do in certain circumstances.

Those examples could provide more explanations on things and give emphasis on "good practices" (Seek or RawCopy, sizeof or len_ or len(), and so on).

In fact, I guess this could be some kind of "tutorial".

I can give an hand on this, but as you already saw, right now, I'm not even able to use the lib the way it should be.

Edit: I know there are big examples in the example dir, but there are no explanation attached, and i.e. not a single Checksum or Compressed. Maybe what I propose is nonsense since there is no need for that for the complete ipstack and ext2 ... or I'm trying particularly rotten proto...

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions