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

Improved documentation for st_retval #61

Merged
merged 2 commits into from
Sep 14, 2018
Merged

Improved documentation for st_retval #61

merged 2 commits into from
Sep 14, 2018

Conversation

wagenet
Copy link
Contributor

@wagenet wagenet commented Sep 13, 2018

No description provided.

chancancode
chancancode requested changes Sep 13, 2018
View reviewed changes
Copy link
Member

@chancancode chancancode left a comment

Choose a reason for hiding this comment

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

This makes the ST_* constants not searchable. It seems fine to document them together on the struct, but they should cross-link to each other.

@chancancode
Copy link
Member

Unrelated to this PR, but we should probably link to the definitions too. As part of that I realized they were defined in st.h (on trunk at least), so we should probably move this into st.rs .

@wagenet
Copy link
Contributor Author

wagenet commented Sep 13, 2018

@chancancode I'll revisit this after we've talked about #62

@chancancode chancancode mentioned this pull request Sep 13, 2018
Merged
@wagenet
Copy link
Contributor Author

wagenet commented Sep 14, 2018

@chancancode should be ready to go now.

@wagenet wagenet merged commit 38f3280 into master Sep 14, 2018
@wagenet wagenet deleted the st_docs branch September 14, 2018 21:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chancancode chancancode chancancode approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@wagenet @chancancode