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.

Sign up for GitHub

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

Jump to bottom

[DOCS] Object #12733

Merged
merged 1 commit into from
Nov 9, 2017
Merged

[DOCS] Object #12733

merged 1 commit into from
Nov 9, 2017

Conversation

NathanWarden
Copy link
Contributor

No description provided.

@akien-mga akien-mga added this to the 3.0 milestone Nov 8, 2017
cbscribe
cbscribe suggested changes Nov 8, 2017
View reviewed changes
Copy link
Contributor

@cbscribe cbscribe left a comment

Choose a reason for hiding this comment

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

You should be consistent in your descriptions. Sometimes you say "the passed", sometimes "the requested ", "the name passed", etc.

You used "this object" sometimes and "the object" other times. I'm recommending you make them all "the object".

You don't need to capitalize "object" when it's referring to a generic object, only when referring to the class itself.

doc/classes/Object.xml Outdated
@@ -281,13 +291,14 @@
<argument index="2" name="method" type="String">
</argument>
<description>
Return true if a connection exists for a given signal and target/method.
Returns [code]true[/code] if a connection exists for a given [code]signal[/code], [code]target[/code] and [code]method[/code].
Copy link
Contributor

Choose a reason for hiding this comment

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

Add comma:
[code]signal[/code], [code]target[/code], and [code]method[/code]

doc/classes/Object.xml Outdated
</description>
</method>
<method name="is_queued_for_deletion" qualifiers="const">
<return type="bool">
</return>
<description>
Returns [code]true[/code] if the [code]queue_free[/code] method was called for this [Node].
Copy link
Contributor

Choose a reason for hiding this comment

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

This object may not be a Node (which inherits from this), so I would just say "was called for the object."

doc/classes/Object.xml Outdated
@@ -268,7 +278,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Check the class of the object against a string (including inheritance).
Returns [code]true[/code] if this Object derives from the [code]type[/code] passed (including inheritance).
Copy link
Contributor

Choose a reason for hiding this comment

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

  • this Object -> the object
  • is or inherits from the given [code]type[/code].

doc/classes/Object.xml Outdated
@@ -253,13 +262,14 @@
<argument index="0" name="signal" type="String">
</argument>
<description>
Returns [code]true[/code] if the given user defined [code]signal[/code] exists.
Copy link
Contributor

Choose a reason for hiding this comment

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

"user-defined"

doc/classes/Object.xml Outdated
@@ -245,6 +253,7 @@
<argument index="0" name="method" type="String">
</argument>
<description>
Returns [code]true[/code] if the Object contains the [code]method[/code] name passed.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Object -> object
  • contains the given [code]method[/code].

doc/classes/Object.xml Outdated
@@ -54,7 +55,7 @@
<argument index="1" name="value" type="Variant">
</argument>
<description>
Set a property. Return true if the property was found.
Sets a property. Returns [code]true[/code] if the [code]property[/code] was found.
Copy link
Contributor

Choose a reason for hiding this comment

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

"was found" -> exists

doc/classes/Object.xml Outdated
@@ -43,7 +44,7 @@
<argument index="0" name="what" type="int">
</argument>
<description>
Notification request, the notification id is received.
Notify this Object internally using an id.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • this Object -> the object
  • id -> ID

doc/classes/Object.xml Outdated
</description>
</method>
<method name="_get_property_list" qualifiers="virtual">
<return type="Array">
</return>
<description>
Return the property list, array of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Returns this Object's property list as an [Array] of dictionaries, dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Copy link
Contributor

Choose a reason for hiding this comment

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

  • this Object -> the object
  • Change comma to period. Second phrase should be a separate sentence.

doc/classes/Object.xml Outdated
@@ -21,20 +21,21 @@
<argument index="0" name="property" type="String">
</argument>
<description>
Return a property, return null if the property does not exist.
Returns a property, returns [code]null[/code] if the [code]property[/code] does not exist.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Returns the given property.
  • Change comma to a period.

doc/classes/Object.xml Outdated
</description>
</method>
<method name="get_property_list" qualifiers="const">
<return type="Array">
</return>
<description>
Return the list of properties as an array of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Returns the list of properties as an [Array] of dictionaries, dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Copy link
Contributor

Choose a reason for hiding this comment

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

Second phrase should be a separate sentence. Add spaces after colons. I think we should use enum links, but I haven't been able to confirm if they're working correctly yet.

@NathanWarden
Copy link
Contributor Author

@cbscribe Thanks Chris, changes are up.

@cbscribe
Copy link
Contributor

cbscribe commented Nov 9, 2017

Thanks for your contribution!

@cbscribe cbscribe merged commit b87a7df into godotengine:master Nov 9, 2017
@NathanWarden
Copy link
Contributor Author

Thanks Chris.

@NathanWarden NathanWarden deleted the document_object branch November 9, 2017 05:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cbscribe cbscribe cbscribe approved these changes

Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
3.0
Development

Successfully merging this pull request may close these issues.
3 participants
@NathanWarden @cbscribe @akien-mga