[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/graphql 2056967feb 38/56: More docstrings
From: |
ELPA Syncer |
Subject: |
[elpa] externals/graphql 2056967feb 38/56: More docstrings |
Date: |
Sat, 29 Oct 2022 13:58:05 -0400 (EDT) |
branch: externals/graphql
commit 2056967febbd832f09f39346f8277e1f4a8cb20d
Author: Sean Allred <code@seanallred.com>
Commit: Sean Allred <code@seanallred.com>
More docstrings
---
graphql.el | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/graphql.el b/graphql.el
index cedb418974..a63d4738ba 100644
--- a/graphql.el
+++ b/graphql.el
@@ -49,6 +49,17 @@
(format "%s:%s" key (graphql--encode-argument-value value)))
(defun graphql--encode-argument-value (value)
+ "Encode an argument value VALUE.
+VALUE is expected to be one of the following:
+
+* a symbol
+* a 'variable', i.e. \\='($ variableName)
+* an object (as a list)
+* a string
+* a vector of values (e.g., symbols)
+* a number
+* something encode-able by `graphql-encode'
+"
(cond
((symbolp value)
(symbol-name value))
@@ -105,6 +116,9 @@ parameter."
"")))
(defun graphql--get-keys (g)
+ "Get the keyword arguments from a graph G.
+Returns a list where the first element is a plist of arguments
+and the second is a 'clean' copy of G."
(or (and (not (consp g))
(list nil g))
(let (graph keys)
@@ -117,7 +131,7 @@ parameter."
(list keys (nreverse graph)))))
(defun graphql-encode (g)
- "Encode G as a GraphQL string."
+ "Encode graph G as a GraphQL string."
(pcase (graphql--get-keys g)
(`(,keys ,graph)
(let ((object (or (car-safe graph) graph))
- [elpa] externals/graphql e755652074 23/56: Various metadata, (continued)
- [elpa] externals/graphql e755652074 23/56: Various metadata, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 6afdd2c8c8 26/56: Update resources, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql df200ddcf5 25/56: New test to ensure we're on the correct tag, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 03d5cc4c3c 27/56: New function graphql-simplify-response-edges, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql c17526d9cd 31/56: Fix compile issues, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 85eac3bbc2 20/56: Rename test file, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql b5a9df03ac 28/56: Separate top-level code-blocks with empty lines, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 164e1b021c 30/56: Merge pull request #1 from tarsius/fixup, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql f5660677d9 35/56: Add documentation, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql f32ffec1a2 37/56: Change macro syntax to be slightly more natural, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 2056967feb 38/56: More docstrings,
ELPA Syncer <=
- [elpa] externals/graphql 72f8c90334 40/56: Merge pull request #2 from tarsiiformes/minor, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql df311b3e31 42/56: Remove '$' from planned features; it is implemented in README, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 82354bb5af 45/56: Run lints as part of CI, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 44af7744d5 48/56: Ignore generated files, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 6c4c5abb26 49/56: Remove defunct test/make.el, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql b64ab8d585 53/56: Do not suggest packaging `examples.el', ELPA Syncer, 2022/10/29
- [elpa] externals/graphql e2b309689f 55/56: Add 'clean' target, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 5ca5f50b5e 56/56: Update MELPA badge to new url, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql d1a8e478b3 21/56: Finish renaming test file, ELPA Syncer, 2022/10/29
- [elpa] externals/graphql 98f9131b27 29/56: Use graphql-encode instead of removed graphql--encode, ELPA Syncer, 2022/10/29