Skip to content

Document representation conversion support matrix#1934

Merged
FlorianPfaff merged 3 commits intofeature/representation-conversion-aliasesfrom
docs/representation-conversion-support-matrix
May 2, 2026
Merged

Document representation conversion support matrix#1934
FlorianPfaff merged 3 commits intofeature/representation-conversion-aliasesfrom
docs/representation-conversion-support-matrix

Conversation

@FlorianPfaff
Copy link
Copy Markdown
Owner

Adds a docs-only support matrix for the representation-conversion gateway introduced in #1929 and extended in #1931.

Main changes:

  • documents supported conversion routes for linear, circular, hypertoroidal, hyperspherical, and hyperhemispherical representations
  • lists concrete target classes selected by aliases such as "particles", "gaussian", "grid", and "fourier"
  • records required conversion parameters such as n_particles, no_of_gridpoints, n_grid_points, no_of_grid_points, grid_type, and n
  • clarifies approximation semantics and the current meaning of the "samples" alias
  • links the API overview to the support matrix

This PR targets feature/representation-conversion-aliases so it can be merged into #1931 before that branch is merged to main.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

MegaLinter analysis: Success

Descriptor Linter Files Fixed Errors Warnings Elapsed time
✅ COPYPASTE jscpd yes no no 14.44s
✅ JSON prettier 2 0 0 0 0.55s
✅ JSON v8r 2 0 0 2.46s
✅ MARKDOWN markdownlint 22 0 0 0 1.11s
✅ MARKDOWN markdown-table-formatter 22 1 0 0 0.25s
✅ PYTHON bandit 447 0 0 6.45s
✅ PYTHON black 447 5 0 0 9.88s
✅ PYTHON flake8 447 0 0 3.44s
✅ PYTHON isort 447 6 0 0 0.8s
✅ PYTHON mypy 447 0 0 5.5s
✅ PYTHON pylint 447 0 0 135.5s
✅ PYTHON ruff 447 6 0 0 0.08s
✅ REPOSITORY checkov yes no no 21.41s
✅ REPOSITORY gitleaks yes no no 10.61s
✅ REPOSITORY git_diff yes no no 0.03s
✅ REPOSITORY secretlint yes no no 8.24s
✅ REPOSITORY syft yes no no 3.64s
✅ REPOSITORY trivy-sbom yes no no 3.29s
✅ REPOSITORY trufflehog yes no no 19.43s
✅ YAML prettier 5 0 0 0 0.53s
✅ YAML v8r 5 0 0 5.47s
✅ YAML yamllint 5 0 0 0.43s

See detailed reports in MegaLinter artifacts

Your project could benefit from a custom flavor, which would allow you to run only the linters you need, and thus improve runtime performances. (Skip this info by defining FLAVOR_SUGGESTIONS: false)

  • Documentation: Custom Flavors
  • Command: npx mega-linter-runner@9.4.0 --custom-flavor-setup --custom-flavor-linters PYTHON_PYLINT,PYTHON_BLACK,PYTHON_FLAKE8,PYTHON_ISORT,PYTHON_BANDIT,PYTHON_MYPY,PYTHON_RUFF,COPYPASTE_JSCPD,JSON_V8R,JSON_PRETTIER,MARKDOWN_MARKDOWNLINT,MARKDOWN_MARKDOWN_TABLE_FORMATTER,REPOSITORY_CHECKOV,REPOSITORY_GIT_DIFF,REPOSITORY_GITLEAKS,REPOSITORY_SECRETLINT,REPOSITORY_SYFT,REPOSITORY_TRIVY_SBOM,REPOSITORY_TRUFFLEHOG,YAML_PRETTIER,YAML_YAMLLINT,YAML_V8R

MegaLinter is graciously provided by OX Security
Show us your support by starring ⭐ the repository

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

Test Results

    12 files  ±0      12 suites  ±0   4h 44m 42s ⏱️ + 2m 45s
 1 281 tests ±0   1 281 ✅ ±0      0 💤 ±0  0 ❌ ±0 
15 736 runs  ±0  12 176 ✅ ±0  3 560 💤 ±0  0 ❌ ±0 

Results for commit 35ccd0d. ± Comparison against base commit dc8ebff.

♻️ This comment has been updated with latest results.

@FlorianPfaff FlorianPfaff merged commit c10bd6f into feature/representation-conversion-aliases May 2, 2026
16 checks passed
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.

1 participant