Skip to content

Question about the reason for @std{in,out,err} complexity #71

Open
@KlfJoat

Description

@KlfJoat

I'm preparing a PR for a feature I want to add (removing the space requirement between the # and the annotations).

In my local copy I've made the shdoc changes and I'm creating test cases for my "nospace" feature based on the current test cases.

The @std{in,out,err} tests are failing. When I went to look at the shdoc code to figure out why, I see a confusing situation for those annotations. Unlike the other multiline annotations (@description, @example), the @std{in,out,err} annotations have a large and complex set of code for the purpose of tracking indentation. But I can't figure out why--what is the use case for tracking indentation on a multiline @stderr block and not a multiline @example block, for example? Why can't a @stdout block be treated the same as a @description block?

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