-
Notifications
You must be signed in to change notification settings - Fork 890
Use &true; &false; &null; semantically where appropriate #862
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -21,7 +21,7 @@ | |
| <refsect1 role="returnvalues"> | ||
| &reftitle.returnvalues; | ||
| <para> | ||
| Shall return true if this Definition is registered | ||
| Shall return &true; if this Definition is registered | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is "shall" the right word here? What is "Definition"? Shouldn't this be the reference to the class name?
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I have a "more notes" file where I am tracking this specific suggestion. I hope that the merging of the improvements in these 300 changes I am proposing can continue without requiring the further incremental changes proposed here and below. We agree that your note is good. We agreed it should be done. I'm noting it. I'll do it. But I don't see anything here which says that that this PR should be considered broken or blocked. |
||
| </para> | ||
| </refsect1> | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ | |
| <para> | ||
| The <function>cubrid_errno</function> function is used to get the | ||
| error code of the error that occurred during the API execution. Usually, | ||
| it gets the error code when API returns false as its return value. | ||
| it gets the error code when API returns &false;. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Nit (consistency): |
||
| </para> | ||
| </refsect1> | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -135,7 +135,7 @@ | |||||
| </term> | ||||||
| <listitem> | ||||||
| <simpara> | ||||||
| Use NULL instead of FALSE on failure. | ||||||
| Use NULL instead of &false; on failure. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| </simpara> | ||||||
| </listitem> | ||||||
| </varlistentry> | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -65,7 +65,7 @@ array(3) { | |||||||||
| Read-through cache callbacks are invoked when an item cannot be retrieved | ||||||||||
| from the server. The callback is passed the Memcached object, the requested | ||||||||||
| key, and the by-reference value variable. The callback is responsible for | ||||||||||
| setting the value and returning true or false. If the callback returns true, | ||||||||||
| setting the value and returning &true; or false. If the callback returns true, | ||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||
| Memcached will store the populated value on the server and return it to the | ||||||||||
| original calling function. Only <methodname>Memcached::get</methodname> and | ||||||||||
| <methodname>Memcached::getByKey</methodname> support these callbacks, | ||||||||||
|
|
||||||||||
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -61,7 +61,7 @@ | |||||
| </listitem> | ||||||
| <listitem> | ||||||
| <para> | ||||||
| <code>required</code>: bool, (optional) true if the field is required to exist in the document. | ||||||
| <code>required</code>: bool, (optional) &true; if the field is required to exist in the document. | ||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| Defaults to &false;, except for <literal>GEOJSON</literal> where it defaults to &true;. | ||||||
| </para> | ||||||
| </listitem> | ||||||
|
|
||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that was mean to be the word "true", not the constant TRUE.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Disagree. Here is the same text without confusing markup:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe "Previously, this would only be the case for methods of classes and traits." would be better.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a "more notes" file where I am tracking this specific suggestion.
I hope that the merging of the improvements in these 300 changes I am proposing can continue without requiring the further incremental changes proposed here and below.
We agree that your note is good. We agreed it should be done. I'm noting it. I'll do it. But I don't see anything here which says that that this PR should be considered broken or blocked.