Skip to content

feat: return path and stable reasons from get_project_metadata - #21

Merged
mcanouil merged 4 commits into
mainfrom
feat/stable-metadata-reasons
Oct 29, 2026
Merged

mcanouil merged 4 commits into
mainfrom
feat/stable-metadata-reasons

Conversation

@mcanouil

Copy link
Copy Markdown
Owner

get_project_metadata now returns the QUARTO_EXECUTE_INFO path as a third value, alongside each of its four failure reasons.
A caller that warns about the file can name it without reading the variable again.

The reasons themselves are now documented as a stable API in the doc comment.
Extensions that keep their own warnings compare against these exact strings, so a rename would silence them with no error.
The existing tests already pin each string, and now also check the returned path.

The in-repo caller, get_project_repo_url, reads only the first value, so it is unchanged.

Callers compare the reason strings, so they are now documented as a stable API. The unreadable case also returns the QUARTO_EXECUTE_INFO path, so a caller can name the file without reading the variable again.
@mcanouil mcanouil added the Type: Enhancement 💡 Issues related to enhancements, improvements, new features, or new analyses label Oct 29, 2026
@mcanouil mcanouil self-assigned this Oct 29, 2026
@mcanouil
mcanouil marked this pull request as ready for review October 29, 2026 15:53
@mcanouil
mcanouil merged commit bb64d5e into main Oct 29, 2026
@mcanouil
mcanouil deleted the feat/stable-metadata-reasons branch October 29, 2026 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Type: Enhancement 💡 Issues related to enhancements, improvements, new features, or new analyses

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant