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

API check for all standard libraries #12285

Merged
merged 11 commits into from
Feb 24, 2025
Merged

Conversation

Akirathan
Copy link
Member

@Akirathan Akirathan commented Feb 14, 2025

Follow-up of #12223 and #12326

Pull Request Description

Introduce API check for the rest of standard libraries.

It is enough to just generate the API signatures with something like:

$ enso --docs api --in-project distribution/lib/Standard/Table/0.0.0-dev/

Important Notes

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    TypeScript,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • Unit tests have been written where possible.
  • If meaningful changes were made to logic or tests affecting Enso Cloud integration in the libraries,
    or the Snowflake database integration, a run of the Extra Tests has been scheduled.
    • If applicable, it is suggested to paste a link to a successful run of the Extra Tests.

@Akirathan Akirathan added the CI: No changelog needed Do not require a changelog entry for this PR. label Feb 14, 2025
@Akirathan Akirathan self-assigned this Feb 14, 2025
@Akirathan
Copy link
Member Author

Wait with integration after #12283 where @radeusgd is changing a lot of signatures for Table.

- default_widget display:Standard.Base.Metadata.Display= -> Standard.Base.Metadata.Widget
- rows_to_read self -> (Standard.Base.Data.Numbers.Integer|Standard.Base.Nothing.Nothing)
- rows_to_write self -> (Standard.Base.Data.Numbers.Integer|Standard.Base.Nothing.Nothing)
- Standard.Table.Rows_To_Read.Rows_To_Read.from that:Standard.Base.Nothing.Nothing -> Standard.Table.Rows_To_Read.Rows_To_Read
Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

It will be valid. It should not be a problem to add the from conversions as well. I think that once #8997 is merged, these markdown files will be valid Enso code, without the leading - prefixes.

@Akirathan Akirathan force-pushed the wip/akirathan/api-check-std-table branch from 43be122 to b29e0ec Compare February 21, 2025 13:20
@github-actions github-actions bot added the -libs-API-change-Table Marks a PR that changes the public API of Standard.Table label Feb 21, 2025
@github-actions github-actions bot added -libs-API-change-Microsoft Marks a PR that changes the public API of Standard.Microsoft -libs-API-change-Google_Api Marks a PR that changes the public API of Standard.Google_Api -libs-API-change-AWS Marks a PR that changes the public API of Standard.AWS -libs-API-change-Image Marks a PR that changes the public API of Standard.Image -libs-API-change-Tableau Marks a PR that changes the public API of Standard.Tableau -libs-API-change-Database Marks a PR that changes the public API of Standard.Database -libs-API-change-Visualization Marks a PR that changes the public API of Standard.Visualization -libs-API-change-Snowflake Marks a PR that changes the public API of Standard.Snowflake -libs-API-change-Test Marks a PR that changes the public API of Standard.Test labels Feb 21, 2025
@Akirathan Akirathan changed the title API check for Standard.Table API check for all standard libraries Feb 21, 2025
@Akirathan Akirathan marked this pull request as ready for review February 21, 2025 13:33
@Akirathan
Copy link
Member Author

The Standard Library API check job correctly detects that all the std libs should be checked.

@Akirathan Akirathan merged commit e002d94 into develop Feb 24, 2025
66 of 67 checks passed
@Akirathan Akirathan deleted the wip/akirathan/api-check-std-table branch February 24, 2025 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
-libs-API-change-AWS Marks a PR that changes the public API of Standard.AWS -libs-API-change-Database Marks a PR that changes the public API of Standard.Database -libs-API-change-Google_Api Marks a PR that changes the public API of Standard.Google_Api -libs-API-change-Image Marks a PR that changes the public API of Standard.Image -libs-API-change-Microsoft Marks a PR that changes the public API of Standard.Microsoft -libs-API-change-Snowflake Marks a PR that changes the public API of Standard.Snowflake -libs-API-change-Table Marks a PR that changes the public API of Standard.Table -libs-API-change-Tableau Marks a PR that changes the public API of Standard.Tableau -libs-API-change-Test Marks a PR that changes the public API of Standard.Test -libs-API-change-Visualization Marks a PR that changes the public API of Standard.Visualization CI: No changelog needed Do not require a changelog entry for this PR.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants