Skip to content

Commit

Permalink
docs: minor consistency on capitalization of versioning concept
Browse files Browse the repository at this point in the history
  • Loading branch information
lostmygithubaccount authored and cpcloud committed Sep 7, 2023
1 parent 57c0596 commit b838760
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
10 changes: 5 additions & 5 deletions docs/concepts/internals.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@

The internals are designed to map the Ibis API to the backend.

## Primary Goals
## Primary goals

1. Type safety
1. Expressiveness
1. Composability
1. Familiarity

## Flow of Execution
## Flow of execution

1. User writes expression
1. Each method or function call builds a new expression
Expand All @@ -31,7 +31,7 @@ expressions in Ibis is the
Expressions provide the user facing API, most of which is defined in
`ibis/expr/api.py`.

### Type System
### Type system

Ibis's type system consists of a set of rules for specifying the types of
inputs to `ibis.expr.types.Node` subclasses. Upon construction of a `Node`
Expand All @@ -50,7 +50,7 @@ Examples of expression types include
[`StringValue`](../reference/expression-strings.qmd#ibis.expr.types.strings.StringValue) and
[`Table`](../reference/expression-tables.qmd#ibis.expr.types.relations.Table).

### The `ibis.expr.types.Node` Class
### The `ibis.expr.types.Node` class

`Node` subclasses make up the core set of operations of Ibis. Each node
corresponds to a particular operation.
Expand Down Expand Up @@ -97,7 +97,7 @@ t = ibis.table([('a', 'float')], name='t')
log_1p = (1 + t.a).log() # an Add and a Log are instantiated here
```

### Expressions vs Operations: Why are they different?
### Expressions vs operations: why are they different?

Separating expressions from their underlying operations makes it easy to
generically describe and validate the inputs to particular nodes. In the log
Expand Down
4 changes: 2 additions & 2 deletions docs/concepts/versioning.qmd
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Versioning Policy
# Versioning policy

Ibis follows a [Semantic Versioning](https://semver.org/) scheme
(`MAJOR.MINOR.PATCH`, like `6.1.0`).
Expand All @@ -14,7 +14,7 @@ Ibis follows a [Semantic Versioning](https://semver.org/) scheme
public APIs that should remain compatible with previous Ibis versions with
the same `MAJOR` version number.

## Supported Python Versions
## Supported Python versions

Ibis follows [NEP29](https://numpy.org/neps/nep-0029-deprecation_policy.html)
with respect to supported Python versions.
Expand Down

0 comments on commit b838760

Please sign in to comment.