vx-lang / vx-lang/Vx

vector types · phase 8: language docs

Open Beginner friendly
#481 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

core-lang documentation
Dominant language
Rust
Stars
14
Forks
2
Avg merge
12h 42m
Merged PRs (30d)
61

Description

Phase 8 of docs/discussions/design-vector-types.md. docs/lang/types.md §8 already states decisions 1, 2, 6 and the pointer rule. Add:

  • the three operations (vector load, splat, reinterpret);
  • the alignment rule: one alignment on the type, under-alignment carried by the pointer;
  • the unsafe surface, including unsafe fn and the Rust-2024 body rule;
  • vectors in ordinary structs, and the extern "C" refusals;
  • the placement sentence: unsafe does not unlock a memory space.

Blocked on Vx#479 and Vx#480.

Contributor guide

No contributing guide indexed for this repository

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

Start with docs/discussions/design-vector-types.md and the existing §8 in docs/lang/types.md, then check Vx#479 and Vx#480 because this phase is blocked on them. Update §8 with the three operations, alignment and unsafe rules, struct and extern "C" behavior, and placement sentence; done means all listed decisions are documented consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
64/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.