Skip to content

docs: Complete nLinq reference documentation#28

Merged
nmaguiar merged 2 commits into
mainfrom
docs-nlinq-reference
May 25, 2025
Merged

docs: Complete nLinq reference documentation#28
nmaguiar merged 2 commits into
mainfrom
docs-nlinq-reference

Conversation

@nmaguiar

Copy link
Copy Markdown
Owner

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.

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.
@nmaguiar nmaguiar requested a review from Copilot May 25, 2025 05:25
@nmaguiar nmaguiar self-assigned this May 25, 2025
@nmaguiar nmaguiar added the documentation Improvements or additions to documentation label May 25, 2025

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread extract_signatures.py Outdated
method_names = set()

# Isolate the 'var code = {...};' block
code_block_match = re.search(r"var code\s*=\s*{((?:.|\n)*?)};", actual_js_code)

Copilot AI May 25, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[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.

Copilot uses AI. Check for mistakes.
@nmaguiar nmaguiar merged commit f6226f5 into main May 25, 2025
1 check passed
@nmaguiar nmaguiar deleted the docs-nlinq-reference branch May 25, 2025 05:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants