Skip to content

refactor: README and documentation links#56

Merged
zlmarshall merged 3 commits into
mainfrom
gguerrie-pypi-docs
Aug 30, 2025
Merged

refactor: README and documentation links#56
zlmarshall merged 3 commits into
mainfrom
gguerrie-pypi-docs

Conversation

@Soap2G
Copy link
Copy Markdown
Contributor

@Soap2G Soap2G commented Aug 30, 2025

Closes #55

Major

  • Rewritten the README to be more concise
  • Linked to the website for documentation
  • Added docs link also in the PyPi config file

Minor

  • Adding example on build_dataset docstring
  • Fixing typos here and there

@Soap2G Soap2G requested review from marianaiv and zlmarshall August 30, 2025 08:09
@codecov
Copy link
Copy Markdown

codecov Bot commented Aug 30, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (ec7180b) to head (892fa1a).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #56   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          247       247           
=========================================
  Hits           247       247           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@zlmarshall zlmarshall left a comment

Choose a reason for hiding this comment

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

This looks great, thanks! Just a few minor questions (and really, questions, not demands!).

The description says you've also updated the PyPI config, but I'm not sure I see how/where that's happening?

Comment thread src/atlasopenmagic/utils.py
Comment thread pyproject.toml
Comment thread README.md
@Soap2G Soap2G self-assigned this Aug 30, 2025
Copy link
Copy Markdown
Contributor

@zlmarshall zlmarshall left a comment

Choose a reason for hiding this comment

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

Awesome, thanks!

@zlmarshall zlmarshall merged commit 0871da0 into main Aug 30, 2025
8 checks passed
@zlmarshall zlmarshall deleted the gguerrie-pypi-docs branch August 30, 2025 21:21
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.

Deploy bitchin new API documentation to PyPI

2 participants