Skip to content

Conversation

@anuthebananu
Copy link
Contributor

@anuthebananu anuthebananu commented Oct 28, 2025

Summary & Motivation

  • Adds API docs for FreshnessPolicy
  • Adds @public annotation to FreshnessPolicy class
  • Moves docstrings from freshness subclasses to their corresponding static constructors
  • Fixes a small bug in mdx generator that did not render newlines correctly in the api docs

How I Tested These Changes

local docs site

Changelog

Insert changelog entry or delete this section.

Copy link
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@anuthebananu anuthebananu changed the title freshness-api-docs [Freshness Policy GA] api docs Oct 28, 2025
@anuthebananu anuthebananu marked this pull request as ready for review October 28, 2025 21:36
@anuthebananu anuthebananu requested a review from a team as a code owner October 28, 2025 21:36
@github-actions
Copy link

github-actions bot commented Oct 28, 2025

Deploy preview for dagster-docs ready!

Preview available at https://dagster-docs-9mvkutpyg-elementl.vercel.app
https://10-28-freshness-api-docs.archive.dagster-docs.io

Direct link to changed pages:

@neverett
Copy link
Contributor

@anuthebananu I'm seeing this docs build error:

[2025-10-29T14:24:42Z] /workdir/python_modules/dagster/dagster/_core/definitions/freshness.py:docstring of dagster._core.definitions.freshness.FreshnessPolicy.time_window:1: WARNING: duplicate object description of dagster.FreshnessPolicy.time_window, other instance in sections/api/apidocs/dagster/assets, use :no-index: for one of them
[2025-10-29T14:24:42Z] /workdir/python_modules/dagster/dagster/_core/definitions/freshness.py:docstring of dagster._core.definitions.freshness.FreshnessPolicy.cron:1: WARNING: duplicate object description of dagster.FreshnessPolicy.cron, other instance in sections/api/apidocs/dagster/assets, use :no-index: for one of them

Are these methods referenced multiple times in assets.rst or defined multiple times in the source code?

Copy link
Contributor Author

I've only added to RST in a single file (docs/sphinx/sections/api/apidocs/dagster/assets.rst) in this PR

Copy link
Contributor Author

i also added @public annotations to the FreshnessPolicy class and the two methods in the error (cron and time_window) - maybe I don't need the methods annotated?

@anuthebananu anuthebananu force-pushed the 10-28-freshness-api-docs branch from fb603cc to 0719e54 Compare October 29, 2025 15:05
Copy link
Contributor Author

Removing the annotation from the methods seems to have fixed things

Copy link
Contributor Author

anuthebananu commented Oct 29, 2025

Merge activity

  • Oct 29, 3:57 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • Oct 29, 3:58 PM UTC: @anuthebananu merged this pull request with Graphite.

@anuthebananu anuthebananu merged commit e3a56cf into master Oct 29, 2025
8 checks passed
@anuthebananu anuthebananu deleted the 10-28-freshness-api-docs branch October 29, 2025 15:58
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.

3 participants