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

Expand documentation #34

Merged
merged 1 commit into from
Jan 29, 2024
Merged

Expand documentation #34

merged 1 commit into from
Jan 29, 2024

Conversation

tarcieri
Copy link
Member

Adds more documentation about the relationship with generic-array.

Also adds better toplevel documentation to the Array type, as well as some initial documentation on AsRef conversions and how to write generic code which presents a const generic API but converts to Array.

Adds more documentation about the relationship with `generic-array`.

Also adds better toplevel documentation to the `Array` type, as well as
some initial documentation on `AsRef` conversions and how to write
generic code which presents a const generic API but converts to `Array`.
@newpavlov
Copy link
Member

newpavlov commented Jan 29, 2024

I think it's worth to move all crate-level docs to README. Right now we have a somewhat strange order of sections, first licensing information and then usage examples.

@tarcieri
Copy link
Member Author

I think it's worth to move all crate-level docs to README.

The problem with that is you can't easily link to types using e.g. Array (with backticks), since when GitHub renders it the link will be dead. So generally I've put any documentation that makes extensive use of that sort of cross-linking/referencing in the rustdoc instead.

@tarcieri tarcieri merged commit befc29d into master Jan 29, 2024
14 checks passed
@tarcieri tarcieri deleted the documentation-improvements branch January 29, 2024 17:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants