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.

Sign up for GitHub

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

Jump to bottom

General improvements to the documentation #375

Merged
merged 5 commits into from
Jul 21, 2021
Merged

General improvements to the documentation #375

merged 5 commits into from
Jul 21, 2021

Commits on Jul 2, 2021

  1. Extract examples from documentation 

    Previously, the example code was all written directly into the
documentation, decoupling it from any real code. This meant changes to
APIs or whatever could unknowningly break the example code, adding to
the number of considerations that a developer would, in theory, be
required to worry about when changing something.

By promoting these examples to real code, we can offload that mental
strain onto the compiler, thus giving us more confidence that the
examples work. In theory, it also means that in the future we could
even add some tests for these to prove they're doing what we claim!
    @swarren12
    swarren12 committed Jul 2, 2021
    Configuration menu
    Copy the full SHA
    ae71a3f View commit details
    Browse the repository at this point in the history

  2. Improve "Using the Disruptor" section 

    Specifically:
  - move the Java 8 examples to the top, as using these features is likely
    to be more common than using the legacy styles
  - replace in-example comments with callouts for better readability
  - general rewording to make it easier to read
    @swarren12
    swarren12 committed Jul 2, 2021
    Configuration menu
    Copy the full SHA
    770bfff View commit details
    Browse the repository at this point in the history

  3. Improve some admonitions

    @swarren12
    swarren12 committed Jul 2, 2021
    Configuration menu
    Copy the full SHA
    d694d72 View commit details
    Browse the repository at this point in the history

  4. Further improve the "Using the" Disruptor section 

    This will fix some grammar warnings and shuffle some paragraphs around.
    @swarren12
    swarren12 committed Jul 2, 2021
    Configuration menu
    Copy the full SHA
    7e5259b View commit details
    Browse the repository at this point in the history

  5. Switch the ASCIIDoctor source highlighter to pygments

    @swarren12
    swarren12 committed Jul 2, 2021
    Configuration menu
    Copy the full SHA
    c19ff8c View commit details
    Browse the repository at this point in the history