IDAES/idaes-pse

Doc string formatter for Google style doc strings

Opened this issue · 1 comments

andrewlee94 commented

Related to #1191

With recent changes to how Pyomo documents ConfigDicts is has come up that the default formatter does not provide full support for Google style doc strings. There are two possible approaches to address this:

  1. Create a new formatter to better handle Google style doc strings, or
  2. Switch to using Numpy style doc strings (which would affect all downstream projects)
dangunter commented

I vote for (1). What exactly is missing?