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

[BUG] Misleading word in Module Manifest section #390

Closed
forszpanen opened this issue Dec 18, 2023 · 2 comments
Closed

[BUG] Misleading word in Module Manifest section #390

forszpanen opened this issue Dec 18, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@forszpanen
Copy link

forszpanen commented Dec 18, 2023

Describe the bug
I'm getting famillair with seedfarmer and I'm not sure if it's a bug or done on purpose but I think if "the name of the group" could be changed into "the name of the module". It would be helpful to underestand what this name means exactly. If I'm wrong just please add more context to this section in documentation.

To Reproduce
https://github.com/awslabs/seed-farmer/blob/54eac1d433c2e2f7eefafb055229814382eb2146/docs/source/manifests.md?plain=1#L247

Expected behavior
the name of the module

@forszpanen forszpanen added the bug Something isn't working label Dec 18, 2023
@dgraeber
Copy link
Contributor

@forszpanen you are correct...that is a typo and I will remediate. It should say "the name of the module".

What the name represents is a logical or physical name. In other words, you can reuse the same module code in the same manifest, but each instance of the module MUST have a unique name in order to be valid.

I will leave this issue open so you can review, but will implement the update in the seedfarmer repository.
Thanks!

@dgraeber
Copy link
Contributor

This has been addressed in awslabs/seed-farmer#468

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants