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
9 changes: 9 additions & 0 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,15 @@ optimal performance, this method should be called with the layouts enabled, with
files organized with folders (see the [advanced section](#disable-layouts)), and
on filters whose information is encoded in the folders.

In case you are working on a small set of data, it is safe to ignore this
warning

```{code-cell}
from fcollections.core import PerformanceWarning
import warnings
warnings.simplefilter("ignore", PerformanceWarning)
```

## Access metadata

The database can display information about the variables and attributes
Expand Down
2 changes: 2 additions & 0 deletions src/fcollections/core/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
FilesDatabase,
IFilterBuilder,
NotExistingPathError,
PerformanceWarning,
SubsetsUnmixer,
)
from ._listing import (
Expand Down Expand Up @@ -114,4 +115,5 @@
"walk",
"VisitResult",
"FileSystemMetadataCollector",
"PerformanceWarning",
]
Loading
Loading