Skip to content

Remove L. from lists documentation examples #115

Description

@mziz

The examples in the lists documentation all follow the convention of importing lists as L and then using L. in the examples:

import lists as L

check:
  [L.list: ] is L.empty
  [L.list: 1] is L.link(1, L.empty)
  [L.list: 1, 2] is L.link(1, link(2, L.empty))
end

since, as far as I know, lists are now in the default context (and most of the contexts that people use), can we get rid of this convention? Other libraries (statistics, math) do not use it. When teaching CSCI0111 at Brown, I find that students find it confusing to see L. in the documentation when first learning to use lists, especially since they don't see me using this syntax in class.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions