Code

Improve documentation#279

Code

Merged

llucax merged 20 commits intofrequenz-floss:v1.x.xfrequenz-floss/frequenz-channels-python:v1.x.xfrom llucax:improve-docsllucax/frequenz-channels-python:improve-docsCopy head branch name to clipboardMar 6, 2024

+115-194

Commits

Commits on Mar 5, 2024

• Add a link to the full documentation in the module docstring

  Show description for 5166b6a
  llucax

  committed
  5166b6a

  Copy full SHA for 5166b6a

• Remove redundant return docs for simple functions

  Show description for f7dfbfc
  llucax

  committed
  f7dfbfc

  Copy full SHA for f7dfbfc

• mkdocs: Show symbol type in the ToC

  Show description for ee234a0
  llucax

  committed
  ee234a0

  Copy full SHA for ee234a0

• Use "this" instead of "the" or "a"

  Show description for 0f830c7
  llucax

  committed
  0f830c7

  Copy full SHA for 0f830c7

• Fix wrong instance name

  Show description for 7fb4fba
  llucax

  committed
  7fb4fba

  Copy full SHA for 7fb4fba

• Capitalize raises documentation

  Show description for c4d061d
  llucax

  committed
  c4d061d

  Copy full SHA for c4d061d

• Improve exceptions descriptions

  Show description for d23b130
  llucax

  committed
  d23b130

  Copy full SHA for d23b130

• Unify the initializer documentation style

  Show description for a532960
  llucax

  committed
  a532960

  Copy full SHA for a532960

• Use "The" more consistently in function arguments

  Show description for be98a83
  llucax

  committed
  be98a83

  Copy full SHA for be98a83

• Improve stop and finalizers documentation

  Show description for 6d52b50
  llucax

  committed
  6d52b50

  Copy full SHA for 6d52b50

• Make string representation compatible with the base class

  Show description for 49e0a4d
  llucax

  committed
  49e0a4d

  Copy full SHA for 49e0a4d

• Remove extra trailing line

  Show description for 41a3912
  llucax

  committed
  41a3912

  Copy full SHA for 41a3912

• Improve the wording

  Show description for 8b7a65b
  llucax

  committed
  8b7a65b

  Copy full SHA for 8b7a65b

• Remove some mentions to channels in sender and receiver

  Show description for 9f0ab3a
  llucax

  committed
  9f0ab3a

  Copy full SHA for 9f0ab3a

• Add missing docstring

  Show description for 226f9fd
  llucax

  committed
  226f9fd

  Copy full SHA for 226f9fd

• Improve wording for getting an async iterator

  Show description for 66bcb60
  llucax

  committed
  66bcb60

  Copy full SHA for 66bcb60

• Improve __repr__ documentation

  Show description for 0ba720f
  llucax

  committed
  0ba720f

  Copy full SHA for 0ba720f

• Rename _Map to _Mapper

  Show description for 6fbf7d2
  llucax

  committed
  6fbf7d2

  Copy full SHA for 6fbf7d2

• Remove some clutter from a user guide example

  Show description for b32bf3b
  llucax

  committed
  b32bf3b

  Copy full SHA for b32bf3b

Commits on Mar 6, 2024

• Apply suggestions from code review

  Show description for f603b47
  

  3 peopleauthored
  f603b47

  Copy full SHA for f603b47