Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documetation fixes #1694

Merged
merged 1 commit into from Dec 16, 2013
Merged

Documetation fixes #1694

merged 1 commit into from Dec 16, 2013

Conversation

John-Colvin
Copy link
Contributor

corrected the documentation for JSON_TYPE and added documentation for JSONValue.this

corrected the documentation for JSON_TYPE and added documentation for JSONValue.this
@yebblies
Copy link
Member

Good.

ARRAY,///
TRUE,///
FALSE,///
NULL ///
Copy link
Collaborator

Choose a reason for hiding this comment

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

Leaving in the word "ditto" is the correct way of doing it. Only the first entry needs to be documented (potentially with nothing , eg ///.
See std.trait's FunctionAttribute.

If you simply put /// it'll create an explicit documentation block, but that contains no text. (creates a paragraph for each entry, instead of creating a paragraph that holds all entries).

Copy link
Member

Choose a reason for hiding this comment

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

And in general, don't destroy that sort of comment alignment. It's far easier to read as it was.

Copy link

Choose a reason for hiding this comment

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

Also that /// integers > 2^63-1 went missing, although I'm not exactly sure what it was trying to imply here.

@braddr
Copy link
Member

braddr commented Nov 16, 2013

I'm removing the auto-merge tag on this commit until the JSON_TYPE comments are cleaned up.

MartinNowak added a commit that referenced this pull request Dec 16, 2013
Documetation fixes

Conflicts:
	std/json.d
@MartinNowak MartinNowak merged commit 8550c88 into dlang:master Dec 16, 2013
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants