la-stack 0.4.3

Fast, stack-allocated linear algebra for fixed dimensions
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

from __future__ import annotations

from typing import TYPE_CHECKING

import check_docs_version_sync

if TYPE_CHECKING:
    from pathlib import Path


def test_find_version_mismatches_accepts_matching_dependency_snippets(tmp_path: Path) -> None:
    (tmp_path / "Cargo.toml").write_text(
        "\n".join(
            [
                "[package]",
                'name = "other-crate"',
                'version = "1.2.3"',
            ]
        ),
        encoding="utf-8",
    )
    (tmp_path / "README.md").write_text(
        "\n".join(
            [
                'other-crate = "1.2.3"',
                'other-crate = { version = "1.2.3", features = ["exact"] }',
                'la-stack = "0.4.1"',
            ]
        ),
        encoding="utf-8",
    )

    assert check_docs_version_sync.find_version_mismatches(tmp_path) == []


def test_find_version_mismatches_reports_stale_dependency_snippets(tmp_path: Path) -> None:
    (tmp_path / "Cargo.toml").write_text(
        "\n".join(
            [
                "[package]",
                'name = "other-crate"',
                'version = "1.2.3"',
            ]
        ),
        encoding="utf-8",
    )
    docs = tmp_path / "docs"
    docs.mkdir()
    (docs / "install.md").write_text(
        'other-crate = { version = "1.2.2", features = ["exact"] }\n',
        encoding="utf-8",
    )

    mismatches = check_docs_version_sync.find_version_mismatches(tmp_path)

    assert len(mismatches) == 1
    assert mismatches[0].snippet.path == docs / "install.md"
    assert mismatches[0].snippet.line == 1
    assert mismatches[0].snippet.version == "1.2.2"
    assert mismatches[0].package.name == "other-crate"
    assert mismatches[0].package.version == "1.2.3"


def test_find_version_mismatches_handles_reordered_inline_table_keys(tmp_path: Path) -> None:
    (tmp_path / "Cargo.toml").write_text(
        "\n".join(
            [
                "[package]",
                'name = "other-crate"',
                'version = "1.2.3"',
            ]
        ),
        encoding="utf-8",
    )
    docs = tmp_path / "docs"
    docs.mkdir()
    install_doc = docs / "install.md"
    install_doc.write_text(
        'other-crate = { features = ["exact"], version = "1.2.2" }\n',
        encoding="utf-8",
    )

    mismatches = check_docs_version_sync.find_version_mismatches(tmp_path)

    assert len(mismatches) == 1
    assert mismatches[0].snippet.path == install_doc
    assert mismatches[0].snippet.line == 1
    assert mismatches[0].snippet.version == "1.2.2"
    assert mismatches[0].package.name == "other-crate"
    assert mismatches[0].package.version == "1.2.3"