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

Documentation convention with consistency #54

Open
svbrodersen opened this issue Feb 27, 2024 · 4 comments
Open

Documentation convention with consistency #54

svbrodersen opened this issue Feb 27, 2024 · 4 comments
Labels
documentation Improvements or additions to documentation

Comments

@svbrodersen
Copy link
Collaborator

No description provided.

@svbrodersen svbrodersen added the documentation Improvements or additions to documentation label Feb 27, 2024
@NiklasPfister
Copy link
Owner

NiklasPfister commented Feb 27, 2024

Conventions:

  • Parameters should be described with full sentences (i.e., starting with a capital letter and ending with a dot).
  • only mention default values when explaining the exact behavior (as defaults are added automatically this avoids mentioning them twice)
  • For parameters that have string values, mention possible values using " "
  • For parameters that have the same behavior as sklearn, use the same description so it is easier for users to know where to expect the same behavior.
  • Index matrices and vectors using square brackets, i.e., X[i, j] for a matrix and v[j] for a matrix. Try to use i for rows and j for columns whenever possible.
  • Sample size should be denoted by n and number of features by p. In particular X is a (n x p)-matrix.
  • X contains the "feature values" and Y the "response values"
  • All input and output types should be defined.

@NiklasPfister NiklasPfister changed the title Documentation convention with consistensy Documentation convention with consistency Mar 5, 2024
@NiklasPfister
Copy link
Owner

Add a page "Contributing" to documentation.

@svbrodersen
Copy link
Collaborator Author

Add internal documentation convention. What functions should have what commens?

@svbrodersen
Copy link
Collaborator Author

Update features to be X and otucomes to be Y throughout the codebase.

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

No branches or pull requests

2 participants