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

Dyn struct creation added to Dyn struct documentation #61

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ZakharEl
Copy link

I demonstrate how to create Dyn structs through the dynptr macro and the from method of the Dyn struct's From trait implementation. My examples demonstrate much of what is described in the Traits section of the Readme. It may not otherwise be apparent to some how to create Dyn structs and DynRef structs. Even for those that do find out how to having these examples makes learning how to occur quicker. This in turn should make your library even more appealing. If the documentation is against your guidelines in any way let me know how it is against your guidelines and I can fix it. I have other ideas for improved documentaton but thought before I write those I should make sure I can submit documentation changes in without clashing with your guidelines. Merci beaucoup pour votre logiciel! Préférez-vous les discussions de demande de tirage en anglais ou français?

…eate Dyn struct from:

- borrows of trait implementors
- heap allocated owned trait implementors
- thread safe owned trait implementors
@p-avital
Copy link
Collaborator

This is lovely, thank you :)

I prefer to keep discussions in English to maximize accessibility, but thanks for offering :)

I have some quick fixing to do now that 1.77 is out to make the CI happy again, in the meantime, would you mind either signing the ECA or simply adding a comment to this PR acknowledging that you are agreeing to your changes being licenced under Eclipse + Apache 2 licensing? :)

@p-avital
Copy link
Collaborator

FYI, I'm looking to relocate your example to somewhere that's both more visible and easier to make compile, since it also acts as a test, but doesn't compile as is due to imports :)

@ZakharEl
Copy link
Author

Ah yeah the breaking change for nightly still plagues the build assuming that get's fixed then the changes I made could be added. Likely under a different pull request. I only changed the document comments not the body of structs, functions, etc. If you point me in the direction of what is wrong then I might be able to fix it. This pull request could be merged now and change nothing in regards to functionality though. It only adds documentation.

@p-avital
Copy link
Collaborator

I've just published 4.0.3 which addresses the breaking change in nightly :)

Working on a proper tutorial for stabby ATM :)

@p-avital
Copy link
Collaborator

For reference, here's the branch on which I'm working on the tutorial: #63

This way of doing things will integrate the tutorial as the documentation for an empty tutorial module, ensuring that all examples compile (or voluntarily fail to compile) and run as expected.

@ZakharEl
Copy link
Author

ZakharEl commented Mar 29, 2024 via email

@ZakharEl
Copy link
Author

ZakharEl commented Apr 2, 2024 via email

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