Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ flowchart TD
- `reader` is a C++ class that implements the logic to read data from binary buffers.
- `factory` is a Python class that creates, combines `reader`s, and post-processes the data read by `reader`s.

This machanism is implemented as `uproot_custom.AsCustom` interpretation. `uproot-custom` wraps `uproot.interpretation.identify.interpretation_of` method to intercept the interpretation of specific branches. This makes `uproot-custom` well compatible with `uproot`.
This machanism is implemented basing on `uproot_custom.AsCustom` interpretation. This makes `uproot-custom` well compatible with `uproot`.

> [!TIP]
> Users can implement their own `factory` and `reader`, register them to `uproot-custom`. An example of implementing a custom `factory`/`reader` can be found in [the repository](https://github.com/mrzimu/uproot-custom/tree/main/example).
> Users can implement their own `factory` and `reader`, register them to `uproot-custom`. An example of implementing a custom `factory`/`reader` can be found in [the example repository](https://github.com/mrzimu/uproot-custom-example).

> [!NOTE]
> `uproot-custom` does not provide a full reimplementation of `ROOT`'s I/O system. Users are expected to implement their own `factory`/`reader` for their custom classes that built-in factories cannot handle.
Expand Down
2 changes: 1 addition & 1 deletion docs/example/override-streamer.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Example 1: `Streamer` method is overridden

```{seealso}
A full example can be found in the `example` directory of [this repo](https://github.com/mrzimu/uproot-custom/tree/main/example).
A full example can be found in the [example repository](https://github.com/mrzimu/uproot-custom-example).
```

We define a demo class `TOverrideStreamer` whose `Streamer` method is overridden to show how to read such classes using `uproot-custom`.
Expand Down
2 changes: 1 addition & 1 deletion docs/example/read-tobjarray.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Example 2: Read `TObjArray` with unique known type

```{seealso}
A full example can be found in the `example` directory of [this repo](https://github.com/mrzimu/uproot-custom/tree/main/example).
A full example can be found in the [example repository](https://github.com/mrzimu/uproot-custom-example).
```

This example shows how to use user-known rules to read data.
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,10 @@ flowchart TD
- `reader` is a C++ class that implements the logic to read data from binary buffers.
- `factory` is a Python class that creates, combines `reader`s, and post-processes the data read by `reader`s.

This machanism is implemented as `uproot_custom.AsCustom` interpretation. `uproot-custom` wraps `uproot.interpretation.identify.interpretation_of` method to intercept the interpretation of specific branches. This makes `uproot-custom` well compatible with `uproot`.
This machanism is implemented as `uproot_custom.AsCustom` interpretation. This makes `uproot-custom` well compatible with `uproot`.

```{tip}
Users can implement their own `factory` and `reader`, register them to `uproot-custom`. An example of implementing a custom `factory`/`reader` can be found in [the repository](https://github.com/mrzimu/uproot-custom/tree/main/example).
Users can implement their own `factory` and `reader`, register them to `uproot-custom`. An example of implementing a custom `factory`/`reader` can be found in [the example repository](https://github.com/mrzimu/uproot-custom-example).
```

```{note}
Expand Down
83 changes: 0 additions & 83 deletions example/README.md

This file was deleted.

31 changes: 0 additions & 31 deletions example/cpp/CMakeLists.txt

This file was deleted.

80 changes: 0 additions & 80 deletions example/cpp/my_reader.cc

This file was deleted.

114 changes: 0 additions & 114 deletions example/gen-demo-data/include/TObjInObjArray.hh

This file was deleted.

16 changes: 0 additions & 16 deletions example/gen-demo-data/include/TOverrideStreamer.hh

This file was deleted.

Loading