You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@geode.apache.org by karensmolermiller <gi...@git.apache.org> on 2017/03/24 22:11:24 UTC
[GitHub] geode-native pull request #75: GEODE-2513 Unbrand .NET API docs section
GitHub user karensmolermiller opened a pull request:
https://github.com/apache/geode-native/pull/75
GEODE-2513 Unbrand .NET API docs section
- Remove references to GemFire
- Namespace updates
- Correct typos and capitalization
- Use .NET scoping operator (not C++)
- Avoid duplication in the manual of QuickStart code
@davebarnes97 @joeymcallister @PivotalSarge @echobravopapa @dgkimura @mmartell
Please give this PR a careful review. The namespace change for .NET clients was tricky, and I'm not sure if the 'Generic' exists for Geode. There were also a few places in the docs that used the C++ scoping operator (::) instead of a period; I think that those were typos in the original documentation.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/karensmolermiller/geode-native feature/GEODE-2513-14
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/geode-native/pull/75.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #75
----
commit 0f8f9913a8251f5bba60acf22624d9d5b513689a
Author: Karen Miller <km...@pivotal.io>
Date: 2017-03-24T21:20:13Z
GEODE-2513 Unbrand .NET API docs section
- Remove references to GemFire
- Namespace updates
- Correct typos and capitalization
- Use .NET scoping operator (not C++)
- Avoid duplication in the manual of QuickStart code
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #75: GEODE-2513 Unbrand .NET API docs section
Posted by PivotalSarge <gi...@git.apache.org>.
Github user PivotalSarge commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/75#discussion_r108524165
--- Diff: docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---
@@ -439,7 +439,7 @@ limitations under the License.
</ul>
</li>
<li class="has_submenu">
- <a href="/docs/guide-native/11/dotnet-caching-api/serialize-using-igfserializable.html">Serialize with the GemFire IGFSerializable Interface</a>
+ <a href="/docs/guide-native/11/dotnet-caching-api/serialize-using-igfserializable.html">Serialize with the Geode IGFSerializable Interface</a>
--- End diff --
I believe `IGFSerializable` has been replaced with `IGeodeSerializable`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #75: GEODE-2513 Unbrand .NET API docs section
Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller closed the pull request at:
https://github.com/apache/geode-native/pull/75
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native issue #75: GEODE-2513 Unbrand .NET API docs section
Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller commented on the issue:
https://github.com/apache/geode-native/pull/75
All corrections have been made. I will merge this PR into develop as soon as the CI build finishes in the green. Thanks for the helpful reviews.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #75: GEODE-2513 Unbrand .NET API docs section
Posted by PivotalSarge <gi...@git.apache.org>.
Github user PivotalSarge commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/75#discussion_r108496561
--- Diff: docs/geode-native-docs/dotnet-caching-api/implementing-igfserializable.html.md.erb ---
@@ -31,21 +31,21 @@ Examples follow the procedure.
void ToData(DataOutput output)
```
- The `ToData` function is responsible for copying all of the data fields for the object to the object stream. The `DataOutput` class represents the output stream and provides methods for writing the primitives in a network byte order. For details, see the API documentation for `DataOutput` at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io).
+ The `ToData` function is responsible for copying all of the data fields for the object to the object stream. The `DataOutput` class represents the output stream and provides methods for writing the primitives in a network byte order.
2. Implement the `FromData` function that consumes a data input stream and repopulates the data fields for the object:
``` pre
void fromData (DataInput& input)
```
- The `DataInput` class represents the input stream and provides methods for reading input elements. The `FromData` function must read the elements of the input stream in the same order that they were written by `ToData`. For more about this, see the API documentation for `DataInput` at [http://gemfire-apis.docs.pivotal.io](http://gemfire-apis.docs.pivotal.io).
+ The `DataInput` class represents the input stream and provides methods for reading input elements. The `FromData` function must read the elements of the input stream in the same order that they were written by `ToData`.
3. Implement the `ClassId` function to return an integer which is unique for your class (in the set of all of your user-defined classes).
## Simple BankAccount Class
-This example shows a simple class, `BankAccount`, that encapsulates two `ints`: `customerId` and `accountId`:
+This example shows a simple class, `BankAccount`, that encapsulates the two `ints` `customerId` and `accountId`:
--- End diff --
Maybe a comma between `ints` and `customerId`?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native pull request #75: GEODE-2513 Unbrand .NET API docs section
Posted by PivotalSarge <gi...@git.apache.org>.
Github user PivotalSarge commented on a diff in the pull request:
https://github.com/apache/geode-native/pull/75#discussion_r108500455
--- Diff: docs/geode-native-book/master_middleman/source/subnavs/geode-nc-nav.erb ---
@@ -473,7 +473,7 @@ limitations under the License.
<a href="/docs/guide-native/11/dotnet-caching-api/resolving-the-error.html">Resolving the Error</a>
</li>
<li>
- <a href="/docs/guide-native/11/dotnet-caching-api/private-assembly.html">Using GemStone.GemFire.Cache.dll As a Private Assembly</a>
+ <a href="/docs/guide-native/11/dotnet-caching-api/private-assembly.html">Using Apache.Geode.Client.dll As a Private Assembly</a>
--- End diff --
I don't see `Apache.Geode.Client.dll`, only `Apache.Geode.dll`, after a Windows installation.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] geode-native issue #75: GEODE-2513 Unbrand .NET API docs section
Posted by karensmolermiller <gi...@git.apache.org>.
Github user karensmolermiller commented on the issue:
https://github.com/apache/geode-native/pull/75
Merged in to develop.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---