Skip to content

Commit e19c553

Browse files
authored
[Doc] Improve spelling (#175)
1 parent 68e77ab commit e19c553

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

cpp/README.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ After the building, you can install the GraphAr C++ library with:
106106
Generate API document
107107
^^^^^^^^^^^^^^^^^^^^^
108108

109-
Building the API document with Doxgen:
109+
Building the API document with Doxygen:
110110

111111
.. code-block:: shell
112112

cpp/test/test_arrow_chunk_writer.cc

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ limitations under the License.
3434
#define CATCH_CONFIG_MAIN
3535
#include <catch2/catch.hpp>
3636

37-
TEST_CASE("test_vertex_property_wrtier_from_file") {
37+
TEST_CASE("test_vertex_property_writer_from_file") {
3838
std::string root;
3939
REQUIRE(GetTestResourceRoot(&root).ok());
4040

docs/user-guide/getting-started.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ The file `person.vertex.yml`_ located inside the test data contains an example o
3131

3232
Edge information
3333
````````````````
34-
Each edge information file defines a single type of edges with specific labels for the source vertex, destination vertex and the edge, e.g., "person_konws_person" in this case. It defines the meta information such as the edge chunk size, the source vertex chunk size, the destination vertex chunk size, if the edges are directed or not, the relative file path for edge data files, the adjLists and the version of GraphAr. The file `person_knows_person.edge.yml`_ located inside the test data contains an example of the edge information file.
34+
Each edge information file defines a single type of edges with specific labels for the source vertex, destination vertex and the edge, e.g., "person_knows_person" in this case. It defines the meta information such as the edge chunk size, the source vertex chunk size, the destination vertex chunk size, if the edges are directed or not, the relative file path for edge data files, the adjLists and the version of GraphAr. The file `person_knows_person.edge.yml`_ located inside the test data contains an example of the edge information file.
3535

3636
In GAR format, separate data files are used to store the structure (called adjList) and the properties for edges. The adjList type can be either of **unordered_by_source**, **unordered_by_dest**, **ordered_by_source** or **ordered_by_dest** (see `Edges in GraphAr <file-format.html#edges-in-graphar>`_ for more). For a specific type of adjList, the meta information includes its file path prefix, the file type, as well as all the property groups attached.
3737

spark/src/main/scala/com/alibaba/graphar/EdgeInfo.scala

+4-4
Original file line numberDiff line numberDiff line change
@@ -106,12 +106,12 @@ class EdgeInfo() {
106106
throw new IllegalArgumentException
107107
}
108108

109-
/** Check if the edge info contains the property group in cerain adj list structure.
109+
/** Check if the edge info contains the property group in certain adj list structure.
110110
*
111111
* @param property_group the property group to check.
112112
* @param adj_list_type the type of adj list structure.
113-
* @return true if the edge info contains the property group in cerain adj list structure.
114-
* If edge info not support the given adj list type or not contains the proerpty group in the adj list structure,
113+
* @return true if the edge info contains the property group in certain adj list structure.
114+
* If edge info not support the given adj list type or not contains the property group in the adj list structure,
115115
* return false.
116116
*/
117117
def containPropertyGroup(property_group: PropertyGroup, adj_list_type: AdjListType.Value): Boolean = {
@@ -388,7 +388,7 @@ class EdgeInfo() {
388388
/** Get the path prefix of the adjacency list topology chunk for the given
389389
* adjacency list type.
390390
* @param adj_list_type type of adj list structure.
391-
* @return path prfix of of the adjacency list topology.
391+
* @return path prefix of of the adjacency list topology.
392392
*/
393393
def getAdjListPathPrefix(adj_list_type: AdjListType.Value) : String = {
394394
return prefix + getAdjListPrefix(adj_list_type) + "adj_list/"

spark/src/main/scala/com/alibaba/graphar/VertexInfo.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class VertexInfo() {
8989
/** Get the data type of property.
9090
*
9191
* @param property_name name of the property.
92-
* @return the data type in gar of the proeprty. If the vertex info does not contains the property,
92+
* @return the data type in gar of the property. If the vertex info does not contains the property,
9393
* raise IllegalArgumentException error.
9494
*/
9595
def getPropertyType(property_name: String): GarType.Value = {

spark/src/main/scala/com/alibaba/graphar/reader/EdgeReader.scala

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import org.apache.spark.sql.functions._
2727
/** Reader for edge chunks.
2828
*
2929
* @constructor create a new edge reader with edge info and AdjList type.
30-
* @param prefix the absolute perfix.
30+
* @param prefix the absolute prefix.
3131
* @param edgeInfo the edge info that describes the edge type.
3232
* @param adjListType the adj list type for the edge.
3333
* @param spark spark session for the reader to read chunks as Spark DataFrame.
@@ -205,7 +205,7 @@ class EdgeReader(prefix: String, edgeInfo: EdgeInfo, adjListType: AdjListType.V
205205
}
206206
}
207207

208-
/** Load the chunks for mutiple property groups of a vertex chunk as a DataFrame.
208+
/** Load the chunks for multiple property groups of a vertex chunk as a DataFrame.
209209
*
210210
* @param propertyGroups list of property groups.
211211
* @param vertex_chunk_index index of vertex chunk.

spark/src/test/scala/com/alibaba/graphar/TestReader.scala

+8-8
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,8 @@ class ReaderSuite extends AnyFunSuite {
3535
// read vertex chunk files in Parquet
3636
val parquet_file_path = "gar-test/ldbc_sample/parquet/"
3737
val parquet_prefix = getClass.getClassLoader.getResource(parquet_file_path).getPath
38-
val parqeut_read_path = parquet_prefix + "vertex/person/id"
39-
val df1 = spark.read.option("fileFormat", "parquet").format("com.alibaba.graphar.datasources.GarDataSource").load(parqeut_read_path)
38+
val parquet_read_path = parquet_prefix + "vertex/person/id"
39+
val df1 = spark.read.option("fileFormat", "parquet").format("com.alibaba.graphar.datasources.GarDataSource").load(parquet_read_path)
4040
// validate reading results
4141
assert(df1.rdd.getNumPartitions == 10)
4242
assert(df1.count() == 903)
@@ -160,12 +160,12 @@ class ReaderSuite extends AnyFunSuite {
160160
// test reading multiple property groups
161161
var property_groups = new java.util.ArrayList[PropertyGroup]()
162162
property_groups.add(property_group)
163-
val mutiple_property_df_chunk_2 = reader.readMultipleEdgePropertyGroupsForVertexChunk(property_groups, 2, false)
164-
assert(mutiple_property_df_chunk_2.columns.size == 1)
165-
assert(mutiple_property_df_chunk_2.count() == 1077)
166-
val mutiple_property_df = reader.readMultipleEdgePropertyGroups(property_groups, false)
167-
assert(mutiple_property_df.columns.size == 1)
168-
assert(mutiple_property_df.count() == 6626)
163+
val multiple_property_df_chunk_2 = reader.readMultipleEdgePropertyGroupsForVertexChunk(property_groups, 2, false)
164+
assert(multiple_property_df_chunk_2.columns.size == 1)
165+
assert(multiple_property_df_chunk_2.count() == 1077)
166+
val multiple_property_df = reader.readMultipleEdgePropertyGroups(property_groups, false)
167+
assert(multiple_property_df.columns.size == 1)
168+
assert(multiple_property_df.count() == 6626)
169169

170170
// test reading all property groups
171171
val all_property_df_chunk_2 = reader.readAllEdgePropertyGroupsForVertexChunk(2, false)

spark/src/test/scala/com/alibaba/graphar/TransformExample.scala

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class TransformExampleSuite extends AnyFunSuite {
3333
.master("local[*]")
3434
.getOrCreate()
3535

36-
test("tranform file type") {
36+
test("transform file type") {
3737
// read from orc files
3838
val file_path = "gar-test/ldbc_sample/orc/"
3939
val prefix = getClass.getClassLoader.getResource(file_path).getPath
@@ -63,7 +63,7 @@ class TransformExampleSuite extends AnyFunSuite {
6363
fs.close()
6464
}
6565

66-
test("tranform adjList type") {
66+
test("transform adjList type") {
6767
val file_path = "gar-test/ldbc_sample/parquet/"
6868
val prefix = getClass.getClassLoader.getResource(file_path).getPath
6969
// get vertex num

0 commit comments

Comments
 (0)