Skip to content

ITiCSE study materials for class-exp and dclass-exp#256

Merged
bnmnetp merged 3 commits intoRunestoneInteractive:masterfrom
barbarer:master
Apr 11, 2023
Merged

ITiCSE study materials for class-exp and dclass-exp#256
bnmnetp merged 3 commits intoRunestoneInteractive:masterfrom
barbarer:master

Conversation

@barbarer
Copy link
Copy Markdown
Contributor

@barbarer barbarer commented Apr 7, 2023

This is to allow ITiCSE study members who already use Runestone ebooks to run the class-exp and dclass-exp studies in their usual ebook

@bnmnetp
Copy link
Copy Markdown
Member

bnmnetp commented Apr 7, 2023

Some of this looks like multiple choice questions, but some of this looks like content??? I thought you were just adding files with questions.

@barbarer
Copy link
Copy Markdown
Contributor Author

barbarer commented Apr 8, 2023 via email

@bnmnetp
Copy link
Copy Markdown
Member

bnmnetp commented Apr 8, 2023

Sorry if I am being dense, but aren't these questions already in the database? So they can already search for them to add to their assignments?

@barbarer
Copy link
Copy Markdown
Contributor Author

barbarer commented Apr 10, 2023 via email

@bnmnetp
Copy link
Copy Markdown
Member

bnmnetp commented Apr 10, 2023

There is not a problem with adding the same question, to multiple books but it is not necessary when you can search for questions across books.

Why we are dumping a pile of new files into a book, but we are not adding anything to the toctree? That creates tons of warnings and confusion about why things are there. Then it gets more confusing because it appears that some of the content duplicates what is already there.

You have said this is part of a study, and this is content that is from one of the books created for the study. What problem are we solving? Or are we creating a bigger problem?

@barbarer
Copy link
Copy Markdown
Contributor Author

barbarer commented Apr 10, 2023 via email

@bnmnetp
Copy link
Copy Markdown
Member

bnmnetp commented Apr 10, 2023

Could we at least put it in its own chapter maybe marked as part of the experiment? We could link it to the TOC as an appendix or something?

@barbarer
Copy link
Copy Markdown
Contributor Author

barbarer commented Apr 10, 2023 via email

@bnmnetp
Copy link
Copy Markdown
Member

bnmnetp commented Apr 10, 2023

That would make it a lot less confusing than having it mixed into the ClassesBasics chapter.

@barbarer
Copy link
Copy Markdown
Contributor Author

I moved the files into a folder called experiments

@bnmnetp bnmnetp merged commit 4168455 into RunestoneInteractive:master Apr 11, 2023
@pearcej
Copy link
Copy Markdown
Contributor

pearcej commented Apr 13, 2023

@bnmnetp @barbarer I have been following this discussion with interest because I am planning to run studies using a different book as well. I think that moving these experiments into a specially named folder is a reasonable solution.

Even so, I agree that throwing unexplained warnings is not great since many people build Runestone books. I wonder if storing them in a specially named folder that clues the build not to throw errors would be an improvement. For example, what if we decided we would always use a folder named experiment or perhaps something like _experiments as a folder name? It should be easy to then never throw warnings on such files not being in the toctree. Furthermore, a folder that begins with an underscore is very unlikely to be a folder that an author would be using for organizational purposes.

Thoughts?

@barbarer
Copy link
Copy Markdown
Contributor Author

barbarer commented Apr 13, 2023 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.

3 participants