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

Documentation has wrong format online #505

Open
zhangysh1995 opened this issue Jun 15, 2021 · 1 comment
Open

Documentation has wrong format online #505

zhangysh1995 opened this issue Jun 15, 2021 · 1 comment

Comments

@zhangysh1995
Copy link

Hi, I found that some parts of the documentation for jepsen.generator has a wrong format.

For example, in the source code there is:

  - The generator may return an operation, in which case:
    - If its time is in the past, we can evaluate it now
    - If its time is in the future, we wait until either:
      - The time arrives
      - Circumstances change (e.g. we update the generator)

But online it is:

  • The generator may return an operation, in which case:
  • If its time is in the past, we can evaluate it now
  • If its time is in the future, we wait until either:
    • The time arrives
    • Circumstances change (e.g. we update the generator)

Similarly, the example code is not in the correct order:

  (op gen test context) => [op gen']      ; known op
                           [:pending gen] ; unsure
                           nil            ; exhausted

(op gen test context) => [op gen’] ; known op [:pending gen] ; unsure nil ; exhausted

I want to know whether I can help to improve it?

@aphyr
Copy link
Collaborator

aphyr commented Jun 15, 2021

Yeah, this is probably a codox markdown thing--I'm usually looking at the source rather than the online docs. You're welcome to fix it if you like!

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

No branches or pull requests

2 participants