Skip to content

Commit

Permalink
Update headings
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Jan 26, 2019
1 parent 9313705 commit 89cd493
Show file tree
Hide file tree
Showing 8 changed files with 25 additions and 41 deletions.
4 changes: 1 addition & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# Release Notes

## 0.1 (2019-01-13)
# 0.1 (2019-01-13)

- Initial release.
18 changes: 8 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Contributor Instructions
# Setup

## Setup

### Requirements
## Requirements

* Make:
* Windows: http://mingw.org/download/installer
Expand All @@ -18,17 +16,17 @@ To confirm these system dependencies are configured correctly:
$ make doctor
```

### Installation
## Installation

Install project dependencies into a virtual environment:

```sh
$ make install
```

## Development Tasks
# Development Tasks

### Manual
## Manual

Run the tests:

Expand All @@ -48,7 +46,7 @@ Build the documentation:
$ make docs
```

### Automatic
## Automatic

Keep all of the above tasks running on change:

Expand All @@ -58,15 +56,15 @@ $ make watch

> In order to have OS X notifications, `brew install terminal-notifier`.
## Continuous Integration
# Continuous Integration

The CI server will report overall build status:

```sh
$ make ci
```

## Release Tasks
# Release Tasks

Release to PyPI:

Expand Down
2 changes: 0 additions & 2 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# License

**The MIT License (MIT)**

Copyright © 2018, Jace Browning
Expand Down
10 changes: 4 additions & 6 deletions docs/options/decorators.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Decorators

## Synchronization
# Synchronization

The simplest way to turn a dataclass into a datafile is to replace the `@dataclass` decorator with `@datafile`:

Expand Down Expand Up @@ -57,7 +55,7 @@ class Item:
available: bool
```

## Options
# Options

The following options can be passed to `@datafile()` decorator:

Expand All @@ -79,7 +77,7 @@ class Item:
available: bool
```

## Meta class
# Meta class

Alternatively, any of the above options can be configured through code by setting `datafile_<option>` in a `Meta` class:

Expand All @@ -99,7 +97,7 @@ class Item:

```

## Base class
# Base class

Finally, a datafile can explicitly extend `datafiles.Model` to set all options in the `Meta` class:

Expand Down
8 changes: 3 additions & 5 deletions docs/options/formats.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Formats

## YAML
# YAML

By default, datafiles uses the [YAML language](https://yaml.org/) for serialization. Any of the following file extensions will use this format:

Expand All @@ -24,7 +22,7 @@ my_str: Hello, world!
Where possible, comments and whitespace are preserved in files as shown in this [Jupyter Notebook](https://github.com/jacebrowning/datafiles/blob/develop/notebooks/roundtrip_comments.ipynb).
## JSON
# JSON
The [JSON language](https://www.json.org/) is also supported. Any of the following file extensions will use this format:
Expand Down Expand Up @@ -54,7 +52,7 @@ Sample output:

Additional examples can be found in this [Jupyter Notebook](https://github.com/jacebrowning/datafiles/blob/develop/notebooks/format_options.ipynb).

## TOML
# TOML

The [TOML language](https://github.com/toml-lang/toml) is also supported. Any of the following file extensions will use this format:

Expand Down
10 changes: 4 additions & 6 deletions docs/types/builtins.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Builtins Types

## Booleans
# Booleans

```python
from typing import Optional
Expand All @@ -13,7 +11,7 @@ from typing import Optional
| `foobar: bool` | `foobar = None` | `foobar: false` |
| `foobar: Optional[bool]` | `foobar = False` | `foobar: ` |

## Integers
# Integers

```python
from typing import Optional
Expand All @@ -26,7 +24,7 @@ from typing import Optional
| `foobar: int` | `foobar = None` | `foobar: 0` |
| `foobar: Optional[int]` | `foobar = None` | `foobar: ` |

## Floats
# Floats

```python
from typing import Optional
Expand All @@ -39,7 +37,7 @@ from typing import Optional
| `foobar: float` | `foobar = None` | `foobar: 0.0` |
| `foobar: Optional[float]` | `foobar = None` | `foobar: ` |

## Strings
# Strings

```python
from typing import Optional
Expand Down
8 changes: 3 additions & 5 deletions docs/types/containers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Container Types

## Lists
# Lists

```python
from typing import List, Optional
Expand All @@ -15,7 +13,7 @@ from typing import List, Optional

More examples can be found in this [Jupyter Notebook](https://github.com/jacebrowning/datafiles/blob/develop/notebooks/patched_containers.ipynb).

## Dictionaries
# Dictionaries

```python
from typing import Dict, Optional
Expand All @@ -30,6 +28,6 @@ from typing import Dict, Optional

**NOTE:** Schema enforcement is not available with the `Dict` annotation.

## Dataclasses
# Dataclasses

Dataclasses can also be nested as shown in this [Jupyter Notebook](https://github.com/jacebrowning/datafiles/blob/develop/notebooks/nested_dataclass.ipynb).
6 changes: 2 additions & 4 deletions docs/types/extensions.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
# Extended Types

## Numbers
# Numbers

```python
from typing import Optional
Expand All @@ -15,7 +13,7 @@ from datafiles.converters import Number
| `foobar: Number` | `foobar = None` | `foobar: 0.0` |
| `foobar: Optional[Number]` | `foobar = None` | `foobar: ` |

## Text
# Text

```python
from typing import Optional
Expand Down

0 comments on commit 89cd493

Please sign in to comment.