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

Test rust docs in rust #112

Merged
merged 8 commits into from
Jan 19, 2024
Merged

Test rust docs in rust #112

merged 8 commits into from
Jan 19, 2024

Conversation

gpwclark
Copy link
Member

  • made a test that checks the format of rust docs, or at least, the strings the get-prop function gets for the :doc-string keywork

  • migrated some docs over from sl-sh

  • added some EXEMPTIONS

  • did a bit of work with the ErrorStrings I'm basing my errors in the conversion lib functions.

main point was to get the docstrings in rust and make sure they were formatted correctly so if you break something in rust, cargo test tells you. obviously incomplete because of the EXEMPTIONS set but it is a start. Mainly a pre-cursor to me actually eval-ing the Example: sections for the docs that do have them.

@gpwclark gpwclark added the enhancement New feature or request label Jan 17, 2024
@gpwclark gpwclark self-assigned this Jan 17, 2024
Copy link
Member

@sstanfield sstanfield left a comment

Choose a reason for hiding this comment

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

This looks good. Thanks for filling out a bunch of the doc strings for the compiler builtins.

@gpwclark gpwclark merged commit f395c0c into master Jan 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants