Skip to content

Commit

Permalink
Update docs/spiders.rst
Browse files Browse the repository at this point in the history
Co-authored-by: James McKinney <26463+jpmckinney@users.noreply.github.com>
  • Loading branch information
yolile and jpmckinney committed Nov 5, 2021
1 parent 2255bf0 commit 6455314
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions docs/spiders.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,17 +90,15 @@ All spiders support these arguments:
- string

.. note::
Depending on the source, a file could be:

- A release package
- A record package
In that case, the sample argument will refer to the number of packages to download.

If a source publishes release packages or record packages, the ``sample`` argument refers to the number of packages to download.

However, if a single file:
However, if a source publishes files that either:

- Contains multiple packages, or
- Contains multiple records or releases not packaged within a package
Each file will be split into multiple file items, and the sample argument will refer to the number of releases or records.
- Contain multiple release packages or record packages
- Contain multiple releases or records that are not within a package

Each file will be split into multiple file items. In this case, the ``sample`` argument refers to the number of file items (packages, releases or records) to download.

Some spiders support these arguments:

Expand Down

0 comments on commit 6455314

Please sign in to comment.