[doc] improve examples #692
Conversation
pbougue
force-pushed
the
improve_examples
branch
from
25311d6
to
c51d6f2
Compare
There was a problem hiding this comment.
nice!
But don't you think the link is a bit easy to miss and that some inline code in the doc would have more impact (with doc-comment, skeptic or whatewhere is the trend now 😜 )
| ); | ||
|
|
||
| // lines passing by stop | ||
| let lines = get(idx, &transit_objects.lines, &transit_objects); |
There was a problem hiding this comment.
completly minor, but don't you think that for the purpose of an example it would be more straightforward to directly use get_corresponding? (at least for the first ones)
There was a problem hiding this comment.
True (especially if it goes in main readme), I tried to mix existing and suggestions 👯
@antoine-de get_corresponding is already well documented in https://github.com/CanalTP/relational_types/blob/master/src/lib.rs |
There was a problem hiding this comment.
@antoine-de I'm OK with your suggestion.
That said:
- I don't think that lib examples should be too prominent compared to bin (maybe move examples below if they are in main readme)
- I don't plan on spending much more time on this major doc refactor topic in the medium term
- I'm OK to merge something that goes that direction (You know, open-source and all 😜 )
| ); | ||
|
|
||
| // lines passing by stop | ||
| let lines = get(idx, &transit_objects.lines, &transit_objects); |
There was a problem hiding this comment.
True (especially if it goes in main readme), I tried to mix existing and suggestions 👯
sure, but it's more difficult to discover as is.
honestly I don't plan on working on transit_model in the mid term, you can do whatever you want with my suggestion 😜 |
fix #329
Also some clippy-related work.