Tour of `L` appears outdated/incorrect

Open Beginner friendly
#799 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
python
Domain
documentation

Research direction

Start with the Tour documentation at https://fastcore.fast.ai/tour.html#l and compare its L examples with the current output shown by the library. Update the outdated representation and truncation examples to match the current behavior, then verify the rendered Tour section and its links.

Written by the indexing model from the issue text.

Description

I'm trying to orientate myself to this library. I'm readying the Tour docs here: https://fastcore.fast.ai/tour.html#l

What the docs say should be in the output and what is in the output appears to have diverged:

On this basis, fastcore has just one type that has a single letter name: [L](https://fastcore.fast.ai/foundation.html#l). The reason for this is that it is designed to be a replacement for list, so we want it to be just as easy to use as [1,2,3]. Here’s how to create that as an [L](https://fastcore.fast.ai/foundation.html#l):

L(1,2,3)

[1, 2, 3]
The first thing to notice is that an [L](https://fastcore.fast.ai/foundation.html#l) object includes in its representation its number of elements; that’s the (#3) in the output above. If there’s more than 10 elements, it will automatically truncate the list:

p = L.range(20).shuffle()
p

[14, 19, 13, 11, 8, 9, 0, 6, 4, 15, 1, 17, 16, 5, 3, 10, 2, 7, 12, 18]
[L](https://fastcore.fast.ai/foundation.html#l) contains many of the same indexing ideas that NumPy’s array does, including indexing with a list of indexes, or a boolean mask list:

There is no #3 in the output, nor does the output of p appear truncated to 10 elements.

Here's a screenshot that shows the formatting better:

Image

(I included the text form assuming y'all might try to have an agent work on this...)

Dominant language
Jupyter Notebook
Stars
1.1k
Forks
295
Avg merge
1d 6h
Merged PRs (30d)
7

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/fastcore

All issues in AnswerDotAI/fastcore

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.