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.

Sign up for GitHub

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

Jump to bottom

in-repo bindings don't explain they are doc-only #1553

Closed
workingjubilee opened this issue Feb 12, 2024 · 2 comments · Fixed by #1573
Closed

in-repo bindings don't explain they are doc-only #1553

workingjubilee opened this issue Feb 12, 2024 · 2 comments · Fixed by #1573
Labels
blocks-0.12.0

Comments

@workingjubilee
Copy link
Member

Just to make it clear that these bindings, as seen, are for documentation purposes.

Should be done as part of a release since that's when we'll regenerate those bindings anyways.
@workingjubilee
Copy link
Member Author

Maybe add in a comment too.

@workingjubilee
Copy link
Member Author

Moving these files is a bad idea, actually. We should emit a comment in the bindgen files.

@workingjubilee workingjubilee changed the title Rename pgrx-pg-sys/src/include to pgrx-pg-sys/src/docs_rs/ Clarify the bindings are for docs only Feb 21, 2024
@workingjubilee workingjubilee changed the title Clarify the bindings are for docs only in-repo bindings don't explain they are doc-only Feb 21, 2024
@workingjubilee workingjubilee mentioned this issue Feb 21, 2024
Merged
workingjubilee added a commit that referenced this issue Feb 22, 2024
@workingjubilee
Add a comment to doc bindings (#1573)
5438837 
People often ask questions about these bindings, but unfortunately they
are not always relevant. They skip past the somewhat-confusing contents
of the include.rs file that manages the cfg here. Explain that these are
doc-only bindings.

Resolves #1553.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
blocks-0.12.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add a comment to doc bindings workingjubilee/pgrx
1 participant
@workingjubilee