-
Notifications
You must be signed in to change notification settings - Fork 13
Overhaul of ServiceX Docs for 3.0 release #444
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## 3.0_develop #444 +/- ##
===============================================
+ Coverage 82.02% 82.92% +0.90%
===============================================
Files 26 26
Lines 1363 1429 +66
===============================================
+ Hits 1118 1185 +67
+ Misses 245 244 -1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
c9f70e4 to
455dcd2
Compare
455dcd2 to
fe50f03
Compare
Readthedocs with pyproject.toml
|
As a final step to merge to 3.0_develop, removing the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These are formatting errors found quickly passing through that are in the changes made. There are others in the docs that aren't in files touch yet, so those should also get fixed.
* First go at a very simple xAOD example * Fix up to use a opendata file for the example. * Remove logging * Working example for simple func_adl * Minor updates to spelling corrections * Add a typed example * Fix up the naming of the typed call * Add the examles to `examples1.rst` * Fix up example to properly reference everything!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please use the Resolves #446 syntax in the body (currently blank) of this PR to close out the issue once this is merged. (#446 (comment))
As a follow up to this, and something that @ponyisi raised on Slack, in the 3.0_develop branch README (https://github.com/ssl-hep/ServiceX_frontend/blob/55d44f08eaae713747b25dcfca3f4910e731762a/README.md) there is no link to any docs in the README.
Please add a link to the ReadTheDocs (https://servicex-frontend.readthedocs.io/) — and maybe also to the dev docs on GitHub pages (https://ssl-hep.github.io/ServiceX_frontend/) — and make the ReadTheDocs versioned and point to stable by default (not latest).
|
Just for future reference (doesn't matter here), putting text in front of |
Uh oh!
There was an error while loading. Please reload this page.