Minor comment updates (#905)

* improve comment

* improve comment

---------

Co-authored-by: Ciaran Schutte <ciaranschutte@oicr.on.ca>

Author: ciaranschutte

modules/server/src/network/resolvers/aggregations.ts

@@ -103,11 +103,13 @@ const convertFieldsToString = (requestedFields: RequestedFieldsMap) => {
 };
 
 /**
- * Query string creation
+ * Creates individual GQL query string for a node.
+ * Includes aggregation GQL arguments (actual data is provided alongside query, not here)
+ * Requested fields are converted to GQL style strings
  *
  * @param documentName
  * @param requestedFields
- * @returns
+ * @returns constructed query string
  */
 export const createNodeQueryString = (
 	documentName: string,

modules/server/src/network/resolvers/index.ts

@@ -12,6 +12,9 @@ export type NetworkSearchRoot = {
 	aggregations: Record<string, unknown>;
 };
 
+/*
+ * Type should match the "Network" GQL type definition arg types
+ */
 export type NetworkAggregationArgs = {
 	filters?: object;
 	aggregations_filter_themselves?: boolean;
@@ -33,7 +36,7 @@ export const createResolvers = (configs: NodeConfig[]) => {
 		Query: {
 			network: async (
 				parent: NetworkSearchRoot,
-				// type should match gql typedefs
+				// as mentioned above, type should match gql typedefs
 				args: NetworkAggregationArgs,
 				context: unknown,
 				info: GraphQLResolveInfo,