Skip to content

[docs] mention of HALO before defining it #158

@LegalizeAdulthood

Description

@LegalizeAdulthood

https://develop.capy.cpp.al/capy/4.coroutines/4a.tasks.html

Key characteristics:
[...]
HALO support — Enables heap allocation elision when possible

When I first read the docs, I had to gargle HALO to understand what it was in this context. Gargle said:

In C++, "halo" usually refers to a halo layer or ghost cells in parallel computing (using MPI) or, less commonly, a compiler optimization (HALO - Heap Allocation Elision Optimization).

For ordinary citizen C++ programmers, I think this should be explained before used in this section, or at least a link around the acronym to some place in boost (or the standard) that already explains it. A footnote explanation should probably be sufficient.

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