Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: restore assets in the documentation #355

Merged
merged 3 commits into from
Oct 25, 2024
Merged

docs: restore assets in the documentation #355

merged 3 commits into from
Oct 25, 2024

Conversation

12rambau
Copy link
Member

@12rambau 12rambau commented Oct 23, 2024

Fix #353

It's a way bigger PR than expected. The disparition of the Asset object from the documentation made me realise that I made a huge mistake when building the files. having a file with the same name as it's unique class (Asset.py, Asset) is crashing the autopai builder becaue it creates a duplicate at the same level in path.sys. This would be irrelevant if we were not dealing with a extention API but as none of our methods are directly called it creates an implicit circular imports of "Asset".

I thus renamed the Asset file into "ee_asset". For consistency I renamed all the other files to ee_<object in snake case>.py. IT IS NOT CHANGING ANYTHING FROM A USER POV.

Also this forced me to revisit the docstring Sphinx roles that is now fully independant from :py:meth:.

Copy link

codecov bot commented Oct 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.13%. Comparing base (434cd40) to head (47f0d76).
Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #355   +/-   ##
=======================================
  Coverage   91.13%   91.13%           
=======================================
  Files          27       27           
  Lines        1646     1646           
  Branches       75       75           
=======================================
  Hits         1500     1500           
  Misses        127      127           
  Partials       19       19           

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

@12rambau 12rambau merged commit 96dc2ec into main Oct 25, 2024
12 checks passed
@12rambau 12rambau deleted the asset branch October 25, 2024 06:39
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.

The Asset object is not referenced in the documentation anymore
1 participant