Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

[complete-doc]: add support for constuctor doc #4861

Conversation

tanmoyopenroot
Copy link
Contributor

PR checklist

Overview of change:

Added new doctype => ARGUMENT_CONSTRUCTORS = "constructors"

Below is the descriptor

    public static ARGUMENT_DESCRIPTOR_CONSTRUCTOR = {
        properties: {
            [DESCRIPTOR_TAGS]: {
                properties: {
                    [TAGS_FOR_CONTENT]: {
                        items: {
                            type: "string",
                        },
                        type: "object",
                    },
                    [TAGS_FOR_EXISTENCE]: {
                        items: {
                            type: "string",
                        },
                        type: "array",
                    },
                },
            },
            [DESCRIPTOR_PRIVACIES]: {
                enum: [ALL, PRIVACY_PRIVATE, PRIVACY_PROTECTED, PRIVACY_PUBLIC],
                type: "string",
            },
            [DESCRIPTOR_OVERLOADS]: {
                type: "boolean",
            },
        },
        type: "object",
    };

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code changes generally LGTM, thanks for sticking to the existing styles! A few small comments here and there; the biggest thing is that protected is missing testing.

@tanmoyopenroot
Copy link
Contributor Author

Code changes generally LGTM, thanks for sticking to the existing styles! A few small comments here and there; the biggest thing is that protected is missing testing.

Done

Copy link
Contributor

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, LGTM. Thanks!

@JoshuaKGoldberg JoshuaKGoldberg merged commit e493270 into palantir:master Oct 10, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

completed-docs does not ask for constructor doc
3 participants