DOC: Update README for ASCL publication and minors#13
Merged
technic960183 merged 3 commits intomainfrom Aug 4, 2025
Merged
Conversation
This package is finally published on ASCL.
markdownlint v0.45.0 MD059/descriptive-link-text: Link text should be descriptive [Context: "[here]"]
🦙 MegaLinter status:
|
| Descriptor | Linter | Files | Fixed | Errors | Warnings | Elapsed time |
|---|---|---|---|---|---|---|
| jscpd | yes | 7 | no | 1.53s | ||
| ✅ JSON | jsonlint | 1 | 0 | 0 | 0.18s | |
| ✅ JSON | v8r | 1 | 0 | 0 | 2.33s | |
| ✅ MARKDOWN | markdownlint | 1 | 0 | 0 | 0.56s | |
| ✅ MARKDOWN | markdown-link-check | 1 | 0 | 0 | 1.53s | |
| ✅ MARKDOWN | markdown-table-formatter | 1 | 0 | 0 | 0.25s | |
| ✅ PYTHON | bandit | 1 | 0 | 0 | 1.25s | |
| ✅ PYTHON | black | 1 | 0 | 0 | 0.78s | |
| ✅ PYTHON | flake8 | 1 | 0 | 0 | 0.55s | |
| ✅ PYTHON | isort | 1 | 0 | 0 | 0.23s | |
| ✅ PYTHON | mypy | 1 | 0 | 0 | 2.96s | |
| ✅ PYTHON | pylint | 1 | 0 | 0 | 2.76s | |
| ✅ PYTHON | ruff | 1 | 0 | 0 | 0.02s | |
| ✅ SPELL | cspell | 5 | 0 | 0 | 2.91s | |
| ✅ SPELL | lychee | 3 | 0 | 0 | 0.48s |
See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff
MegaLinter is graciously provided by OX Security
technic960183
force-pushed
the
gh-update-info
branch
from
f335ccf to
e725c2a
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the README documentation to reflect ASCL (Astrophysics Source Code Library) publication and includes various documentation improvements. The changes enhance citation instructions by providing proper academic references and updating copyright information to include 2025.
- Added ASCL and ADS badges to the README for academic visibility
- Updated citation section with ASCL Bibcode and proper BibTeX format
- Updated copyright years from 2024 to 2023-2025 across files
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| README.md | Added ASCL/ADS badges, updated citation section with proper academic references, improved language clarity |
| docs/source/conf.py | Updated copyright year to include 2023-2025 |
| LICENSE.txt | Updated copyright year to include 2023-2025 |
| .github/linters/.cspell.json | Added spelling exceptions for ASCL-related terms |
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
1 participant
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.
Purpose
Improve documentation, enhance citation details for the
spherimatchproject, and update licensing and copyright information.Major Change
Minor Change
2023-2024to2023-2025.