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.

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

[Bug]: PEP 257 enforcment #93

Open
yardasol opened this issue Dec 17, 2021 · 0 comments
Open

[Bug]: PEP 257 enforcment #93

yardasol opened this issue Dec 17, 2021 · 0 comments

Comments

@yardasol
Copy link
Contributor

Expected behavior

All docstrings follow PEP 257

Describe the bug

Not all docstrings follow PEP 257. The following excerpt is relevant here:

The docstring for a class should summarize its behavior and list the public methods and instance variables. If the class is intended to be subclassed, and has an additional interface for subclasses, this interface should be listed separately (in the docstring). The class constructor should be documented in the docstring for its init method. Individual methods should be documented by their own docstring.

I have identified the following classes that need to list methods and parameters in the class docstring in order to comply with PEP 257

  • depcode.Depcode
  • depcode.DepcodeSerpent
  • materialflow.Materialflow
  • process.Process
  • reactor.Reactor
  • simulation.Simulation

To Reproduce

Steps to reproduce the behavior:

  1. Read the PEP 257 linked above.
  2. Verify that the listed classes do not comply.

Supporting information

@LukeSeifert identified this issue in #87

System Specifications:

  • Software version: Saltproc v0.3.0

How can this issue be closed?

This issue can be closed when a PR that fixes the issue is merged into master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant