Skip to content

Commit

Permalink
Don't hardwrap lines (#959)
Browse files Browse the repository at this point in the history
* Use single-line paragraphs

* Use single-line paragraphs

* Fix note syntax

* Have empty line between paragraphs
  • Loading branch information
peterdesmet authored Jul 8, 2024
1 parent bf159fd commit e304cc0
Show file tree
Hide file tree
Showing 6 changed files with 90 additions and 351 deletions.
274 changes: 42 additions & 232 deletions content/docs/recipes/enum-labels-and-ordering.md

Large diffs are not rendered by default.

17 changes: 5 additions & 12 deletions content/docs/recipes/files-inside-archives.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,17 @@ title: Files Inside Archives
</tr>
</table>

Some datasets need to contain a Zip file (or tar, other formats) containing a
set of files.
Some datasets need to contain a Zip file (or tar, other formats) containing a set of files.

This might happen for practical reasons (datasets containing thousands of files)
or for technical limitations (for example, currently Zenodo doesn't support subdirectories and
datasets might need subdirectory structures to be useful).
This might happen for practical reasons (datasets containing thousands of files) or for technical limitations (for example, currently Zenodo doesn't support subdirectories and datasets might need subdirectory structures to be useful).

## Implementations

There are no known implementations at present.

## Specification

The `resources` in a `data-package` can contain "recursive resources": identifying
a new resource.
The `resources` in a `data-package` can contain "recursive resources": identifying a new resource.

## Example

Expand Down Expand Up @@ -67,9 +63,6 @@ For a `.tar.gz` it would be the same changing the `"format"` and the

## Types of files

Support for `Zip` and `tar.gz` might be enough: hopefully everything can be
re-packaged using these formats.
Support for `Zip` and `tar.gz` might be enough: hopefully everything can be re-packaged using these formats.

To keep the implementation and testing testing: only one recursive level is
possible. A `resource` can list `resources` inside (like in the example). But
the inner resources cannot contain resources again.
To keep the implementation and testing testing: only one recursive level is possible. A `resource` can list `resources` inside (like in the example). But the inner resources cannot contain resources again.
12 changes: 3 additions & 9 deletions content/docs/recipes/json-data-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,7 @@ A **JSON Data Resource** is a type of [Data Resource][dr] specialized for descri

JSON Data Resource extends [Data Resource][dr] in following key ways:

- The `schema` property MUST follow the [JSON Schema](https://json-schema.org/) specification,
either as a JSON object directly under the property, or a string referencing another
JSON document containing the JSON Schema
- The `schema` property MUST follow the [JSON Schema](https://json-schema.org/) specification, either as a JSON object directly under the property, or a string referencing another JSON document containing the JSON Schema

## Examples

Expand Down Expand Up @@ -121,12 +119,8 @@ A JSON Data Resource MUST be a [Data Resource][dr], that is it MUST conform to t

In addition:

- The Data Resource `schema` property MUST follow the [JSON Schema](https://json-schema.org/) specification,
either as a JSON object directly under the property, or a string referencing another
JSON document containing the JSON Schema

* There `MUST` be a `profile` property with the value `json-data-resource`

- The Data Resource `schema` property MUST follow the [JSON Schema](https://json-schema.org/) specification, either as a JSON object directly under the property, or a string referencing another JSON document containing the JSON Schema
- There `MUST` be a `profile` property with the value `json-data-resource`
- The data the Data Resource describes MUST, if non-inline, be a JSON file

## JSON file requirements
Expand Down
2 changes: 2 additions & 0 deletions content/docs/recipes/relationship-between-fields.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,9 @@ The control implementation is based on the following principles:
- comparison of the calculated relationship type with that defined in the data schema

The [implementation example](https://github.com/loco-philippe/Environmental-Sensing/blob/main/property_relationship/example.ipynb) presents calculation function.

An [analysis tool](https://github.com/loco-philippe/tab-analysis/blob/main/README.md) is also available and accessible from pandas data.

An example of implementation as `custom_check` is available [here](https://nbviewer.org/github/loco-philippe/Environmental-Sensing/blob/main/property_relationship/relationship_descriptor.ipynb).

## Notes
Expand Down
Loading

0 comments on commit e304cc0

Please sign in to comment.