search

ethereum / lahja

Lahja is a generic multi process event bus implementation written in Python 3.6+ to enable lightweight inter-process communication, based on non-blocking asyncio
MIT License
394 stars 19 forks source link

Improve visuals of API docs #152

Closed cburgdorf closed 5 years ago

cburgdorf commented 5 years ago

What was wrong?

  1. Lots of grey boxes make API docs harder to parse (visually)

  2. Methods and attributes not being grouped makes it even harder and error prone for the reader ("Do I call this with or without parenthesis?")

Visuals today:

image

How was it fixed?

  1. Removed grey boxes
  2. Improved fonts and spacing
  3. Grouped methods and attributes

Visuals after this PR:

improved_api_docs

To-Do

Cute Animal Picture

put a cute animal picture link inside the parentheses