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] Add titles to properties and methods sections in API Reference #10821

Merged
merged 9 commits into from
Jan 17, 2025

Conversation

JessSaavedra
Copy link
Contributor

@JessSaavedra JessSaavedra commented Jan 3, 2025

Description

Add titles to properties and methods sections in API Reference pages as suggested in the mockup: https://www.figma.com/design/8tOPFUmGKoKVVdFBthjJgZ/API-Doc?node-id=36-580&t=OJzTqULmss3N2Irt-0

Deploy preview: https://deploy-preview-10821.docs.greatexpectations.io/docs/reference/api/data_context/AbstractDataContext_class

Screenshots

Before

screencapture-docs-greatexpectations-io-docs-reference-api-data-context-AbstractDataContext-class-2025-01-14-18_26_08

After

screencapture-deploy-preview-10821-docs-greatexpectations-io-docs-reference-api-data-context-AbstractDataContext-class-2025-01-15-17_33_23

  • Description of PR changes above includes a link to an existing GitHub issue
  • PR title is prefixed with one of: [BUGFIX], [FEATURE], [DOCS], [MAINTENANCE], [CONTRIB]
  • Code is linted - run invoke lint (uses ruff format + ruff check)
  • Appropriate tests and docs have been updated

For more information about contributing, visit our community resources.

After you submit your PR, keep the page open and monitor the statuses of the various checks made by our continuous integration process at the bottom of the page. Please fix any issues that come up and reach out on Slack if you need help. Thanks for contributing!

@JessSaavedra JessSaavedra changed the title [DOCS] WIP - Add Databricks datasource to corresponding expectations [DOCS] WIP - Improve API reference pages structure Jan 3, 2025
Copy link

netlify bot commented Jan 3, 2025

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit 8f202ce
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/678aa1d9fd2d4300083e0437
😎 Deploy Preview https://deploy-preview-10821.docs.greatexpectations.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

codecov bot commented Jan 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.70%. Comparing base (1fb3981) to head (8f202ce).
Report is 2 commits behind head on develop.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop   #10821      +/-   ##
===========================================
- Coverage    80.74%   80.70%   -0.04%     
===========================================
  Files          465      465              
  Lines        40547    40547              
===========================================
- Hits         32739    32725      -14     
- Misses        7808     7822      +14     
Flag Coverage Δ
3.10 70.02% <ø> (-0.04%) ⬇️
3.10 aws_deps ?
3.10 big ?
3.10 clickhouse ?
3.10 mssql ?
3.10 mysql ?
3.10 postgresql ?
3.10 spark_connect ?
3.10 trino ?
3.11 70.02% <ø> (-0.04%) ⬇️
3.11 athena or openpyxl or pyarrow or project or sqlite or aws_creds ?
3.11 aws_deps ?
3.11 big ?
3.11 clickhouse ?
3.11 filesystem ?
3.11 mssql ?
3.11 mysql ?
3.11 postgresql ?
3.11 spark_connect ?
3.11 trino ?
3.12 70.02% <ø> (-0.04%) ⬇️
3.12 athena or openpyxl or pyarrow or project or sqlite or aws_creds 56.40% <ø> (-0.03%) ⬇️
3.12 aws_deps 46.25% <ø> (ø)
3.12 big 54.77% <ø> (-0.03%) ⬇️
3.12 bigquery 48.54% <ø> (ø)
3.12 databricks 50.30% <ø> (ø)
3.12 filesystem 62.78% <ø> (-0.03%) ⬇️
3.12 mssql 51.30% <ø> (-0.03%) ⬇️
3.12 mysql 51.71% <ø> (-0.03%) ⬇️
3.12 postgresql 54.35% <ø> (-0.03%) ⬇️
3.12 snowflake 51.10% <ø> (ø)
3.12 spark 57.68% <ø> (ø)
3.12 spark_connect 46.55% <ø> (-0.03%) ⬇️
3.12 trino 52.26% <ø> (ø)
3.9 70.04% <ø> (-0.04%) ⬇️
3.9 athena or openpyxl or pyarrow or project or sqlite or aws_creds 56.40% <ø> (-0.03%) ⬇️
3.9 aws_deps 46.27% <ø> (-0.03%) ⬇️
3.9 big 54.78% <ø> (-0.03%) ⬇️
3.9 bigquery 48.53% <ø> (ø)
3.9 clickhouse 43.17% <ø> (-0.03%) ⬇️
3.9 databricks 50.30% <ø> (-0.01%) ⬇️
3.9 filesystem 62.79% <ø> (-0.03%) ⬇️
3.9 mssql 51.28% <ø> (-0.03%) ⬇️
3.9 mysql 51.69% <ø> (-0.03%) ⬇️
3.9 postgresql 54.34% <ø> (-0.03%) ⬇️
3.9 snowflake 51.10% <ø> (ø)
3.9 spark 57.64% <ø> (ø)
3.9 spark_connect 46.56% <ø> (ø)
3.9 trino 52.24% <ø> (ø)
cloud 0.00% <ø> (ø)
docs-basic 53.91% <ø> (-0.03%) ⬇️
docs-creds-needed 52.84% <ø> (ø)
docs-spark 52.33% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@JessSaavedra JessSaavedra force-pushed the DOC-966_improve_api_reference_styles branch from 21cc810 to 2a8cdfb Compare January 14, 2025 21:21
@JessSaavedra JessSaavedra changed the title [DOCS] WIP - Improve API reference pages structure [DOCS] Add titles to properties and methods sections in API Reference Jan 14, 2025
@JessSaavedra JessSaavedra force-pushed the DOC-966_improve_api_reference_styles branch from 6f61905 to fb49e02 Compare January 14, 2025 21:24
Copy link
Member

@josectobar josectobar left a comment

Choose a reason for hiding this comment

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

Looks great! I have a small nit pick.

docs/sphinx_api_docs_source/utils.py Outdated Show resolved Hide resolved
@JessSaavedra JessSaavedra added this pull request to the merge queue Jan 17, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jan 17, 2025
@JessSaavedra JessSaavedra added this pull request to the merge queue Jan 17, 2025
Merged via the queue into develop with commit e1a3a29 Jan 17, 2025
70 checks passed
@JessSaavedra JessSaavedra deleted the DOC-966_improve_api_reference_styles branch January 17, 2025 20:34
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.

2 participants