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] API docs support self referential links #6998

Merged
merged 6 commits into from Jan 31, 2023

Conversation

anthonyburdi
Copy link
Member

Changes proposed in this pull request:

  • Links were failing on entities that referenced themselves, e.g. ExpectationSuiteValidationResult which is referenced as a type accepted in the meta field:
class ExpectationSuiteValidationResult(SerializableDictDot):
    def __init__(
        self,
        success: Optional[bool] = None,
        results: Optional[list] = None,
        evaluation_parameters: Optional[dict] = None,
        statistics: Optional[dict] = None,
        meta: Optional[ExpectationSuiteValidationResult | dict] = None,
        ge_cloud_id: Optional[UUID] = None,
    ) -> None:

Definition of Done

  • My code follows the Great Expectations style guide
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have run any local integration tests and made sure that nothing is broken.

@anthonyburdi anthonyburdi self-assigned this Jan 31, 2023
@netlify
Copy link

netlify bot commented Jan 31, 2023

Deploy Preview for niobium-lead-7998 ready!

Name Link
🔨 Latest commit c416fdf
🔍 Latest deploy log https://app.netlify.com/sites/niobium-lead-7998/deploys/63d86105356d28000959d743
😎 Deploy Preview https://deploy-preview-6998--niobium-lead-7998.netlify.app
📱 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 settings.

@ghost
Copy link

ghost commented Jan 31, 2023

👇 Click on the image for a new way to code review
  • Make big changes easier — review code in small groups of related files

  • Know where to start — see the whole change at a glance

  • Take a code tour — explore the change with an interactive tour

  • Make comments and review — all fully sync’ed with github

    Try it now!

Review these changes using an interactive CodeSee Map

Legend

CodeSee Map Legend

@anthonyburdi anthonyburdi enabled auto-merge (squash) January 31, 2023 00:29
@anthonyburdi anthonyburdi merged commit cd941d5 into develop Jan 31, 2023
@anthonyburdi anthonyburdi deleted the d/dx-267/fix_api_docs_sidebar branch January 31, 2023 00:37
Shinnnyshinshin pushed a commit that referenced this pull request Jan 31, 2023
…on' of https://github.com/great-expectations/great_expectations into m/_/typing-data-assistant-result-and-metric-configuration

* 'm/_/typing-data-assistant-result-and-metric-configuration' of https://github.com/great-expectations/great_expectations:
  [DOCS] `Expectations` related DocStrings (#6994)
  [DOCS] Add rendering docstrings (#6992)
  [DOC] ColumnExpectation, render_evaluation_parameter_string and validate method (#6995)
  [DOCS] API docs support self referential links (#6998)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants