LispCookbook / LispCookbook/cl-cookbook

Improve the section on the different arguments to make-array

Open
#534 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

pull request accepted
Dominant language
JavaScript
Stars
1.1k
Forks
158
Avg merge
6d 3h
Merged PRs (30d)
2

Description

Currently it doesn't really state what the consequences and usecases of :displaced-to, :fill-pointer or :adjustable are or the type safety implications of :element-type.

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.

Research direction

Search the cookbook for the section discussing the different arguments to make-array and read its current explanation. Expand that section to cover the consequences and use cases of :displaced-to, :fill-pointer, and :adjustable, plus the type-safety implications of :element-type; the documentation is done when these topics are clearly explained.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.