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

Throw exception when ExtractFrontMatter is called without child modules #277

Open
holly-hacker opened this issue May 5, 2024 · 1 comment
Labels
⚠️ Bug Something isn't working as expected

Comments

@holly-hacker
Copy link

holly-hacker commented May 5, 2024

I just spent an embarrassing amount of time debugging why my ExtractFrontMatter module wasn't working, as it wasn't outputting the new modules with the front matter removed. It turns out that I had to pass in a ParseYaml or similar module to do the actual parsing of the frontmatter, or else it will not do anything. This wasn't clear from the documentation.

I suggest throwing an exception if no child module is passed, to prevent others from wasting multiple hours pulling their hair out trying to figure out how this framework works and why it's not doing what you expect :)

@daveaglick
Copy link
Member

daveaglick commented May 5, 2024

Great idea! In fact, I'm going to classify this as a bug since it doesn't make any functional sense to have a module that requires child modules silently fail if no children are there.

@daveaglick daveaglick added the ⚠️ Bug Something isn't working as expected label May 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚠️ Bug Something isn't working as expected
Development

No branches or pull requests

2 participants