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.

Sign up for GitHub

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

Jump to bottom

Doc string formatter for Google style doc strings #1196

Open
andrewlee94 opened this issue Jun 1, 2023 · 1 comment
Open

Doc string formatter for Google style doc strings #1196

andrewlee94 opened this issue Jun 1, 2023 · 1 comment
Assignees
@jsiirola
Labels
backward-compat Affects backward compatibility discussion Discussion documentation Documentations comments and requests Priority:Low Low Priority Issue or PR

Comments

@andrewlee94
Copy link
Member

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)
@andrewlee94 andrewlee94 added documentation Documentations comments and requests Priority:Low Low Priority Issue or PR discussion Discussion backward-compat Affects backward compatibility labels Jun 1, 2023
@ksbeattie ksbeattie added Priority:Low Low Priority Issue or PR and removed documentation Documentations comments and requests Priority:Low Low Priority Issue or PR backward-compat Affects backward compatibility labels Jun 1, 2023
@andrewlee94 andrewlee94 added documentation Documentations comments and requests backward-compat Affects backward compatibility labels Jun 1, 2023
@lbianchi-lbl lbianchi-lbl mentioned this issue Jun 1, 2023
Closed
@dangunter
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jsiirola jsiirola

Labels
backward-compat Affects backward compatibility discussion Discussion documentation Documentations comments and requests Priority:Low Low Priority Issue or PR
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@jsiirola @dangunter @ksbeattie @andrewlee94