Use tables to summarize course content #2005
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is more friendly to translation (as it can share the translation of the title).
mgeisler
approved these changes
Apr 19, 2024
mdbook-course/src/course.rs
Outdated
| pub fn outline(&self, at_source_path: impl AsRef<Path>) -> String { | ||
| let mut outline = String::from("In this segment:\n"); | ||
| pub fn outline(&self) -> String { | ||
| let mut slides = Table::new(["Slide".into(), "Time".into()]); |
There was a problem hiding this comment.
Would it be slightly more accurate to call this a "duration"?
Suggested change
| let mut slides = Table::new(["Slide".into(), "Time".into()]); | |
| let mut slides = Table::new(["Slide".into(), "Duration".into()]); |
mdbook-course/src/course.rs
Outdated
| outline | ||
| format!( | ||
| "Including {BREAK_DURATION} minute breaks, this session should take about {}. It contains:\n\n{}", | ||
| duration(self.minutes()),segments) |
There was a problem hiding this comment.
I think your rustfmt has given up here 😄
Suggested change
| duration(self.minutes()),segments) | |
| duration(self.minutes()), segments) |
There was a problem hiding this comment.
I think it doesn't do much in macro invocations? I was surprised by this too.
mdbook-course/src/course.rs
Outdated
| pub fn outline(&self, at_source_path: impl AsRef<Path>) -> String { | ||
| let mut outline = String::from("In this session:\n"); | ||
| pub fn outline(&self) -> String { | ||
| let mut segments = Table::new(["Segment".into(), "Time".into()]); |
There was a problem hiding this comment.
Perhaps "duration" is better here?
Suggested change
| let mut segments = Table::new(["Segment".into(), "Time".into()]); | |
| let mut segments = Table::new(["Segment".into(), "Duration".into()]); |
mdbook-course/src/course.rs
Outdated
| session.name, | ||
| duration(session.minutes()) | ||
| ) | ||
| .unwrap(); | ||
| let mut segments = Table::new(["Segment".into(), "Time".into()]); |
There was a problem hiding this comment.
Suggested change
| let mut segments = Table::new(["Segment".into(), "Time".into()]); | |
| let mut segments = Table::new(["Segment".into(), "Duration".into()]); |
| @@ -57,6 +58,46 @@ pub fn duration(mut minutes: u64) -> String { | |||
| } | |||
| } | |||
|
|
|||
| /// Table implements Display to format a two-dimensional table as markdown, | |||
| /// following https://github.github.com/gfm/#tables-extension-. | |||
| pub struct Table<const N: usize> { | |||
There was a problem hiding this comment.
Nice! If you have time, it would be nice to have a small unit test below to show how the output looks like.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is more friendly to translation (as it can share the translation of the title).
This fixes #1982.