docs: Complete nLinq reference documentation#28
Merged
Conversation
I've filled in missing sections in REFERENCE.md for nLinq functionality, including: - Methods for restricting by value matching (contains, empty, match and variants) - Methods for restricting by value type (type, is and variants) - Methods for changing the current result set (each, intersect, attach, sort, etc.) - Additional SELECT methods (groupBy, fnBy, minBy, maxBy, etc.) - Query structure and logical modifiers (useCase, begin, and, or, etc.) I also reviewed and corrected existing documentation for accuracy and clarity.
There was a problem hiding this comment.
Pull Request Overview
This pull request updates the nLinq reference documentation with additional method details and examples while adding two new scripts to extract JavaScript method signatures from the source file.
- Completed missing sections and improved clarity in REFERENCE.md for nLinq functionalities.
- Added extract_signatures.py to extract method names with a simple regex.
- Added extract_method_names.py to extract method names with an alternative regex approach.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| extract_signatures.py | New script for extracting method signatures from nlinq.js using regex patterns. |
| extract_method_names.py | New script offering an alternative regex approach for extracting method names. |
| REFERENCE.md | Updated and expanded documentation for various nLinq methods with examples and tables. |
Comments suppressed due to low confidence (1)
REFERENCE.md:101
- The heading 'Restriciting prefixes and suffixes' appears to contain a spelling error. Please change it to 'Restricting prefixes and suffixes'.
### Restriciting prefixes and suffixes
| method_names = set() | ||
|
|
||
| # Isolate the 'var code = {...};' block | ||
| code_block_match = re.search(r"var code\s*=\s*{((?:.|\n)*?)};", actual_js_code) |
There was a problem hiding this comment.
[nitpick] The regex pattern used to isolate the code block may not correctly handle nested braces in JavaScript objects. Consider using a more robust pattern or parser if the js_file structure becomes more complex.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I've filled in missing sections in REFERENCE.md for nLinq functionality, including:
I also reviewed and corrected existing documentation for accuracy and clarity.