Code

Imperative doc strings#3792

Code

Merged

janosh merged 12 commits intomastermaterialsproject/pymatgen:masterfrom doc-stringsmaterialsproject/pymatgen:doc-stringsCopy head branch name to clipboardApr 30, 2024

+782-1,161

Commits

Commits on Apr 30, 2024

• standardize first line class doc strings to imperative style

  Show description for ec2fee6
  janosh

  committed
  ec2fee6

• imperative doc strings

  janosh

  committed
  0ffd247

• imperative doc strings

  janosh

  committed
  1a5ca3d

• revert np.mean to np.average where passing weight kwarg

  janosh

  committed
  b375d85

• imperative doc strings

  janosh

  committed
  0ef0210

• """Returns -> """Get

  janosh

  committed
  a2469cb

• remove "Returns:" from property doc strings

  janosh

  committed
  3e2b25a

• bug fix: as_dict should not have been property on SeparationPlane and ExplicitPermutationsAlgorithm

  janosh

  committed
  70255d0

• format property doc strings with leading line break

  janosh

  committed
  58a1021

• ", e.g.," -> ", e.g."

  janosh

  committed
  366e738

• remove leading "Get" from property doc strings

  janosh

  committed
  74429b7

• Fix TestCoordinationGeometries using as_dict as property which should have been normal method all along

  janosh

  committed
  2210c5d