Skip to content

Include docs for with re-exported functions with -femit-docs. #3673

Closed
@nmichaels

Description

@nmichaels

An example: math.zig includes the following code:

pub const isSignalNan = @import("math/isnan.zig").isSignalNan;

The generated docs for the math namespace show no documentation for this function. However, in math/isnan.zig, there's this:

/// Returns whether x is a signalling nan.
pub fn isSignalNan(x: var) bool {

Which is exactly where the documentation for the function ought to be. I'm proposing that the generated documentation should, when displaying a symbol that's just re-exported from a different Zig module in this rather common idiom, include that symbol's documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsenhancementSolving this issue will likely involve adding new logic or components to the codebase.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions