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: NumPy-Financial should have a documented style guide #74

Open
Kai-Striega opened this issue Nov 14, 2023 · 0 comments
Open

DOC: NumPy-Financial should have a documented style guide #74

Kai-Striega opened this issue Nov 14, 2023 · 0 comments
Assignees
@Kai-Striega
Labels
documentation Improvements or additions to documentation
Milestone
2.0

Comments

@Kai-Striega
Copy link
Member

Kai-Striega commented Nov 14, 2023 •
edited
Loading

Issue with current documentation:

NumPy-Financial currently does not have a documented style guide

Idea or request for content:

Write a style guide for others to follow, the guide should be based of:

  • PEP8 for general code, except the line length should be 88 characters
  • numpydoc for documentation

Some further documents to consider:

In case of ambiguity, we follow the NumPy style guide
@Kai-Striega Kai-Striega added the documentation Improvements or additions to documentation label Nov 14, 2023
@Kai-Striega Kai-Striega added this to the 2.0 milestone Nov 14, 2023
@Kai-Striega Kai-Striega self-assigned this Nov 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Kai-Striega Kai-Striega

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
2.0
Development

No branches or pull requests
1 participant
@Kai-Striega