You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by ma...@apache.org on 2016/02/26 04:34:35 UTC
[1/5] lucy-clownfish git commit: Fix minor nits.
Repository: lucy-clownfish
Updated Branches:
refs/heads/master b9f22d149 -> ac9fc2bb5
Fix minor nits.
* Not all host bindings other than C support default values.
* Formatting and grammar nits.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/cd4b623b
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/cd4b623b
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/cd4b623b
Branch: refs/heads/master
Commit: cd4b623bbf3389fb1f2375c5889b6366f2af0d92
Parents: b9f22d1
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Thu Feb 25 19:27:34 2016 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Thu Feb 25 19:27:34 2016 -0800
----------------------------------------------------------------------
runtime/core/Clownfish/Docs/WritingClasses.md | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/cd4b623b/runtime/core/Clownfish/Docs/WritingClasses.md
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Docs/WritingClasses.md b/runtime/core/Clownfish/Docs/WritingClasses.md
index 5e79788..bbd4f6d 100644
--- a/runtime/core/Clownfish/Docs/WritingClasses.md
+++ b/runtime/core/Clownfish/Docs/WritingClasses.md
@@ -132,13 +132,13 @@ This will generate:
### Class exposure
-API documentation will only be generated for classes with public exposure.
+API documentation will only be generated for classes with `public` exposure.
### Inert classes
Inert classes must contain only inert variables or inert functions, that is,
neither instance variables nor methods. They must not inherit from another
-class or be inherited from. They're essentially nothing more than a
+class nor be inherited from. They're essentially nothing more than a
namespace for functions and global variables.
### Final classes
@@ -240,7 +240,7 @@ Example using short names:
### Function exposure
-API documentation will only be generated for functions with public exposure.
+API documentation will only be generated for functions with `public` exposure.
### Inert functions
@@ -405,7 +405,7 @@ This is typically used in container classes like Vector:
Default parameter values can be given as integer, float, or string literals.
The values `true`, `false`, and `NULL` are also supported. The default
-values are only used by the host language bindings. They're not supported
+values are only used by certain host language bindings. They're not supported
when calling a function from C.
## C blocks
[5/5] lucy-clownfish git commit: Merge branch 'misc_doc_fixes'
Posted by ma...@apache.org.
Merge branch 'misc_doc_fixes'
Make minor doc updates found after reviewing the generated Perl
documentation.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/ac9fc2bb
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/ac9fc2bb
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/ac9fc2bb
Branch: refs/heads/master
Commit: ac9fc2bb5d8c0c21f81c36b9d8d3f7438f070b53
Parents: b9f22d1 ef6d3e0
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Thu Feb 25 19:34:26 2016 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Thu Feb 25 19:34:26 2016 -0800
----------------------------------------------------------------------
runtime/core/Clownfish/Class.cfh | 7 +++----
runtime/core/Clownfish/Docs/WritingClasses.md | 8 ++++----
runtime/core/Clownfish/Hash.cfh | 12 ++++++------
runtime/core/Clownfish/String.cfh | 6 +++---
runtime/core/Clownfish/Vector.cfh | 8 ++++----
runtime/perl/buildlib/Clownfish/Build/Binding.pm | 3 +--
6 files changed, 21 insertions(+), 23 deletions(-)
----------------------------------------------------------------------
[3/5] lucy-clownfish git commit: Remove outdated bug warning.
Posted by ma...@apache.org.
Remove outdated bug warning.
This bug was fixed a while ago.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/8802f656
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/8802f656
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/8802f656
Branch: refs/heads/master
Commit: 8802f6565cd92f083129ab5a9d69a6701e6251f2
Parents: 2c7c9a5
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Thu Feb 25 19:32:31 2016 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Thu Feb 25 19:32:31 2016 -0800
----------------------------------------------------------------------
runtime/perl/buildlib/Clownfish/Build/Binding.pm | 3 +--
1 file changed, 1 insertion(+), 2 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/8802f656/runtime/perl/buildlib/Clownfish/Build/Binding.pm
----------------------------------------------------------------------
diff --git a/runtime/perl/buildlib/Clownfish/Build/Binding.pm b/runtime/perl/buildlib/Clownfish/Build/Binding.pm
index 2ee3da0..b58205a 100644
--- a/runtime/perl/buildlib/Clownfish/Build/Binding.pm
+++ b/runtime/perl/buildlib/Clownfish/Build/Binding.pm
@@ -724,8 +724,7 @@ recommended above isn't compatible with ithreads.
=item *
Overridden methods must not return undef unless the API specifies that
-returning undef is permissible. (Failure to adhere to this rule currently
-results in a segfault rather than an exception.)
+returning undef is permissible.
=back
[4/5] lucy-clownfish git commit: Minor formatting,
wordsmithing and typo fixes.
Posted by ma...@apache.org.
Minor formatting, wordsmithing and typo fixes.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/ef6d3e0f
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/ef6d3e0f
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/ef6d3e0f
Branch: refs/heads/master
Commit: ef6d3e0fde6f3929e8865888508f5ef81503ddb1
Parents: 8802f65
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Thu Feb 25 19:33:24 2016 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Thu Feb 25 19:33:55 2016 -0800
----------------------------------------------------------------------
runtime/core/Clownfish/Hash.cfh | 12 ++++++------
runtime/core/Clownfish/String.cfh | 6 +++---
runtime/core/Clownfish/Vector.cfh | 8 ++++----
3 files changed, 13 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/Hash.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Hash.cfh b/runtime/core/Clownfish/Hash.cfh
index 320138d..590d3c9 100644
--- a/runtime/core/Clownfish/Hash.cfh
+++ b/runtime/core/Clownfish/Hash.cfh
@@ -75,7 +75,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj {
/** Fetch the value associated with `key`.
*
- * @return the value, or NULL if `key` is not present.
+ * @return the value, or [](@null) if `key` is not present.
*/
public nullable Obj*
Fetch(Hash *self, String *key);
@@ -84,7 +84,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj {
*
* @param utf8 Pointer to UTF-8 character data of the key.
* @param size Size of UTF-8 character data in bytes.
- * @return the value, or NULL if `key` is not present.
+ * @return the value, or [](@null) if `key` is not present.
*/
public nullable Obj*
Fetch_Utf8(Hash *self, const char *utf8, size_t size);
@@ -92,7 +92,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj {
/** Attempt to delete a key-value pair from the hash.
*
* @return the value if `key` exists and thus deletion
- * succeeds; otherwise NULL.
+ * succeeds; otherwise [](@null).
*/
public incremented nullable Obj*
Delete(Hash *self, String *key);
@@ -102,7 +102,7 @@ public final class Clownfish::Hash inherits Clownfish::Obj {
* @param utf8 Pointer to UTF-8 character data of the key.
* @param size Size of UTF-8 character data in bytes.
* @return the value if `key` exists and thus deletion
- * succeeds; otherwise NULL.
+ * succeeds; otherwise [](@null).
*/
public incremented nullable Obj*
Delete_Utf8(Hash *self, const char *utf8, size_t size);
@@ -112,12 +112,12 @@ public final class Clownfish::Hash inherits Clownfish::Obj {
public bool
Has_Key(Hash *self, String *key);
- /** Return a Vector of pointers to the hash's keys.
+ /** Return the Hash's keys.
*/
public incremented Vector*
Keys(Hash *self);
- /** Return a Vector of pointers to the hash's values.
+ /** Return the Hash's values.
*/
public incremented Vector*
Values(Hash *self);
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/String.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/String.cfh b/runtime/core/Clownfish/String.cfh
index af63773..9d38890 100644
--- a/runtime/core/Clownfish/String.cfh
+++ b/runtime/core/Clownfish/String.cfh
@@ -312,21 +312,21 @@ public final class Clownfish::String nickname Str
public incremented String*
To_String(String *self);
- /** Return a a copy of the String with Unicode whitespace characters
+ /** Return a copy of the String with Unicode whitespace characters
* removed from both top and tail. Whitespace is any character that has
* the Unicode property `White_Space`.
*/
public incremented String*
Trim(String *self);
- /** Return a a copy of the String with leading Unicode whitespace
+ /** Return a copy of the String with leading Unicode whitespace
* removed. Whitespace is any character that has the Unicode property
* `White_Space`.
*/
public incremented String*
Trim_Top(String *self);
- /** Return a a copy of the String with trailing Unicode whitespace
+ /** Return a copy of the String with trailing Unicode whitespace
* removed. Whitespace is any character that has the Unicode property
* `White_Space`.
*/
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/ef6d3e0f/runtime/core/Clownfish/Vector.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Vector.cfh b/runtime/core/Clownfish/Vector.cfh
index b671261..608779c 100644
--- a/runtime/core/Clownfish/Vector.cfh
+++ b/runtime/core/Clownfish/Vector.cfh
@@ -89,7 +89,7 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj {
public void
Store(Vector *self, size_t tick, decremented Obj *elem = NULL);
- /** Replace an element in the Vector with NULL and return it.
+ /** Replace an element in the Vector with [](@null) and return it.
*
* @return the element stored at `tick` or [](@null) if `tick` is out of
* bounds.
@@ -97,7 +97,7 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj {
public incremented nullable Obj*
Delete(Vector *self, size_t tick);
- /** Remove `length` elements from the vector, starting at `offset`.
+ /** Remove `length` elements from the Vector, starting at `offset`.
* Move elements over to fill in the gap.
*/
public void
@@ -138,8 +138,8 @@ public final class Clownfish::Vector nickname Vec inherits Clownfish::Obj {
size_t
Get_Capacity(Vector *self);
- /** Return a new vector consisting of elements from a contiguous slice. If
- * the specified range is out of bounds, return an vector with fewer
+ /** Return a new Vector consisting of elements from a contiguous slice. If
+ * the specified range is out of bounds, return a Vector with fewer
* elements -- potentially none.
*
* @param offset The index of the element to start at.
[2/5] lucy-clownfish git commit: Minor wordsmithing of docs.
Posted by ma...@apache.org.
Minor wordsmithing of docs.
Project: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/commit/2c7c9a53
Tree: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/tree/2c7c9a53
Diff: http://git-wip-us.apache.org/repos/asf/lucy-clownfish/diff/2c7c9a53
Branch: refs/heads/master
Commit: 2c7c9a538b53cb5e15499e43cebfff0433a048fd
Parents: cd4b623
Author: Marvin Humphrey <ma...@rectangular.com>
Authored: Thu Feb 25 19:32:04 2016 -0800
Committer: Marvin Humphrey <ma...@rectangular.com>
Committed: Thu Feb 25 19:32:04 2016 -0800
----------------------------------------------------------------------
runtime/core/Clownfish/Class.cfh | 7 +++----
1 file changed, 3 insertions(+), 4 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucy-clownfish/blob/2c7c9a53/runtime/core/Clownfish/Class.cfh
----------------------------------------------------------------------
diff --git a/runtime/core/Clownfish/Class.cfh b/runtime/core/Clownfish/Class.cfh
index a5c83ab..bdef4fb 100644
--- a/runtime/core/Clownfish/Class.cfh
+++ b/runtime/core/Clownfish/Class.cfh
@@ -18,9 +18,8 @@ parcel Clownfish;
/** Class.
*
- * Classes, which are the first element in any Clownfish object, are actually
- * objects themselves. (Their first element is a Class which describes the
- * behavior of Classes.)
+ * Classes are first-class objects in Clownfish. Class objects are instances
+ * of Clownfish::Class.
*/
public final class Clownfish::Class inherits Clownfish::Obj {
@@ -130,7 +129,7 @@ public final class Clownfish::Class inherits Clownfish::Obj {
public nullable Class*
Get_Parent(Class *self);
- /** Return the number of bytes needed to hold an object the class.
+ /** Return the number of bytes needed to hold an instance of the class.
*/
public uint32_t
Get_Obj_Alloc_Size(Class *self);