numpy / numpy/numpy-financial

DOC: NumPy-Financial should have a documented style guide

Open
#74 0 comments 0 reactions 1 assignee View on GitHub

@Kai-Striega is already working on this.

Since Nov 14, 2023.

documentation
Dominant language
Python
Stars
409
Forks
98
Avg merge
10h 43m
Merged PRs (30d)
12

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.