practicalli / practicalli/clojure

Clojure documentation convensions

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

@practicalli-johnny is already working on this.

Since Jun 10, 2023.

documentation
Dominant language
Makefile
Stars
117
Forks
36
PR merge metrics
No merged PRs in 30d

Description

core libraries use the following conventions when naming arguments

f, g, h - function
n - integer, usually a size
index, i - integer index
x, y - numbers
xs - sequence
m - map
s - string
re - regular expression
coll - a collection
pred - a predicate closure
& more - variable number of arguments

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.