doc: make doc examples testable in ci #326
Conversation
dj8yfo
force-pushed
the
testable_docs_of_derive_macros
branch
from
8a33f86 to
865fe12
Compare
| pub fn add_definitions_recursively<K: BorshSchema, V: BorshSchema>( | ||
| definitions: &mut BTreeMap<Declaration, Definition>, | ||
| ) { | ||
| let definition = Definition::Sequence { | ||
| elements: <(K, V)>::declaration(), | ||
| length_width: Definition::DEFAULT_LENGTH_WIDTH, | ||
| length_range: Definition::DEFAULT_LENGTH_RANGE, | ||
| }; | ||
| let no_recursion_flag = definitions.get(&declaration::<K, V>()).is_none(); | ||
| schema::add_definition(declaration::<K, V>(), definition, definitions); | ||
| if no_recursion_flag { | ||
| <(K, V)>::add_definitions_recursively(definitions); | ||
| } | ||
| } |
There was a problem hiding this comment.
this api was actually out of date
dj8yfo
force-pushed
the
testable_docs_of_derive_macros
branch
from
da1d6fc to
ba3b63a
Compare
|
@race-of-sloths include |
|
@dj8yfo Thank you for your contribution! Your pull request is now a part of the Race of Sloths! Current status: executed
Your contribution is much appreciated with a final score of 8! @akorchyn received 25 Sloth Points for reviewing and scoring this pull request. Another weekly streak completed, well done @dj8yfo! To keep your weekly streak and get another bonus make pull request next week! Looking forward to see you in race-of-sloths What is the Race of SlothsRace of Sloths is a friendly competition where you can participate in challenges and compete with other open-source contributors within your normal workflow For contributors:
For maintainers:
Feel free to check our website for additional details! Bot commands
|
There was a problem hiding this comment.
To be honest, not sure that I like the idea of moving docs into the md as it ruins the developer experience when you jump from the IDE. Just a point for you to think 👍🏻
@race-of-sloths score 8
| use core::hash::Hash; | ||
|
|
||
| /// this a stub module, representing a 3rd party crate `indexmap` | ||
| mod indexmap { |
There was a problem hiding this comment.
We might hide it I guess
resolves #325
the meaningful part of changes are in commits named
doc: replace ignore -> rust whereever possibleand the like