Skip to content

[Documentation] API ref does not show outs #56

Description

@internetfishy

Making an issue here as it is documentation related, original is here: Facepunch/sbox-public#10513

The current website API doesn't properly show out parameters. This can make it harder to distinguish how things work when using the API.

Eg. PolygonMesh on the API page shows DetachFaces takes two inputs;

Image

In the code however it only takes one input and has an out parameter:

Image

This obviously makes things difficult and is misleading for anyone using the website API.

EDIT:

This has been partially fixed in more recent updates, but still not entirely clear in some areas.

PolygonMesh still lists it's function as taking two arguments with no out listed.

Image

However the method itself now provides clarity.

Image

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