Skip to content

Conversation

@vickysharma0812
Copy link
Member

This pull request introduces a variety of changes across configuration files, documentation, and code formatting. The most notable updates include the addition of a comprehensive configuration file for Marksman, the creation of a new blog post detailing mesh generation in EASIFEM, and numerous formatting improvements in documentation tables for better readability.

Configuration Updates:

  • .marksman.toml: Added a detailed configuration file for Marksman, including markdown settings, text synchronization protocol, and code action toggles. This file provides default values and explanations for each option.
  • .yarnrc.yml: Added the ignoreEngines setting to bypass engine compatibility checks.

Documentation Enhancements:

  • docs/blog/generating-2d-mesh-in-easifem.md: Introduced a new blog post explaining methods for generating structured 2D meshes in EASIFEM, with detailed code examples and illustrations.
  • Multiple files in docs/docs-api/ARPACK/: Improved table formatting for arguments and results, ensuring consistent alignment and readability across documentation. [1] [2] [3] [4] [5] [6] [7] [8]

Code Formatting:

  • CONTRIBUTING.md: Replaced bold text with italicized text for better stylistic consistency.
  • babel.config.js: Updated quotes from single to double for consistency with other code conventions.

Content Removal:

These changes collectively enhance the project's configuration, documentation clarity, and code formatting standards.

Add test program for GetValue: integer vector extraction from TOML file

- Implements main program to test GetValue for integer vectors from various TOML and text/csv sources.
- Uses modules: GlobalData, TomlUtility, tomlf, Test_Method, ExceptionHandler_Class.
- Includes assertions for correct extraction of integer arrays from different keys.
@vickysharma0812 vickysharma0812 requested a review from Copilot June 4, 2025 02:24
@vickysharma0812 vickysharma0812 self-assigned this Jun 4, 2025
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances project configuration, updates documentation formatting, and adds a new tutorial post for mesh generation.

  • Introduces a detailed Marksman configuration and bypasses engine checks in Yarn.
  • Adds a new blog post on generating 2D meshes in EASIFEM.
  • Improves table formatting across ARPACK reference files and other docs.

Reviewed Changes

Copilot reviewed 1748 out of 1748 changed files in this pull request and generated no comments.

Show a summary per file
File Description
.marksman.toml Adds default Marksman LSP settings and explanations
.yarnrc.yml Enables ignoreEngines to skip engine checks
docs/blog/generating-2d-mesh-in-easifem.md New tutorial on creating structured 2D meshes
docs/docs-api/ARPACK/_ARPACK_test_3.md Adjusts Markdown table separators
docs/docs-api/ARPACK/_ARPACK_test_2.md Standardizes table header separators
docs/docs-api/ARPACK/SSEUPD.md Updates table delimiter row formatting
docs/docs-api/ARPACK/SSAUPD.md Reformats tables & (inadvertently) truncates rows
docs/about/SystemRequirements.md Aligns table formatting for system requirements
docs/about/extpkgs.md Simplifies info block syntax
docs/about/easifemMaterials.md Removes placeholder content
docs/blog/how-to-setup-a-new-kernel-in-easifem.md Strips trailing whitespace
CONTRIBUTING.md Switches bold to italic for style consistency
CODE_OF_CONDUCT.md Replaces guidelines link with a TODO marker
babel.config.js Harmonizes quote style
Comments suppressed due to low confidence (4)

docs/docs-api/ARPACK/SSAUPD.md:575

  • The error description for code -5 was truncated to only 'LM'. It should list all valid options ('LM', 'SM', 'LA', 'SA', 'BE') as before.
| -5    | WHICH must be one of 'LM'                                       |

docs/docs-api/ARPACK/SSAUPD.md:580

  • The error description for code -10 was shortened to only 'must be 1'. It should include the full range of allowed values (1–5).
| -10   | IPARAM(7) must be 1                                             |

docs/docs-api/ARPACK/_ARPACK_test_3.md:67

  • [nitpick] The table separator uses only two dashes per column, which may not match header widths and could break rendering. Consider using a consistent '---' or matching number of dashes.
| -- | -- | -- | -- | -- |

CODE_OF_CONDUCT.md:3

  • Replacing the community guidelines link with 'TODO' removes critical guidance. Please restore a valid link or include the appropriate conduct text.
TODO

@vickysharma0812 vickysharma0812 merged commit b101452 into main Jun 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants