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

Fix typos in project README file #170

Merged
merged 1 commit into from
Aug 17, 2021
Merged

Fix typos in project README file #170

merged 1 commit into from
Aug 17, 2021

Conversation

Potherca
Copy link
Member

Closes #167
Closes #168

@kirchsth
Copy link
Contributor

Hi @Potherca,
in Readme.md we are using long descriptive argument names, but the correct argument names are shorter.
Should we use the short names in readme too (technology..techn, description..descr)?
e.g.

Container(alias, label, technology, ?description, ?sprite, ?tags, $link)
Container($alias, $label, $techn, $descr="", $sprite="", $tags="", $link="")

BR Helmut

@Potherca
Copy link
Member Author

@kirchsth That would lead to more changes than I currently have the mental bandwidth / feel comfortable with making.

It is welcome as a separate issue/MR.

@Potherca Potherca modified the milestones: v2.4.0, v2.3.1 Aug 17, 2021
@kirchsth
Copy link
Contributor

@Potherca: OK I will fix it in one of my following changes.

@Potherca Potherca merged commit e0dde16 into master Aug 17, 2021
@Potherca Potherca deleted the docs/typo branch August 17, 2021 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Typo in doc - notice an extra ` symbol in #Element properties Typo in doc - &textColor should be $textColor
2 participants