emicklei / dot

Go package for writing descriptions using the Graphviz DOT and Mermaid language
MIT License
282 stars 19 forks source link

Fix lint warnings #37

Closed erikbryant closed 10 months ago

erikbryant commented 10 months ago

Mostly, fix some small typos.

Rename 'dot' to 'dotFile' since 'dot' shadows an imported package of the same name. Since we are renaming 'dot', also rename the corresponding 'href' variable so they are of consistent form.

Rename 'MermaidShapeCirle' to 'MermaidShapeCircle' as the former was likely a typo.

Verified by running 'go test ./...' and confirming all tests passed.

emicklei commented 10 months ago

thank for your contribution that improves the readability ; did not know I made that many typos.

erikbryant commented 10 months ago

I am using your dot package. Thank you for it! In using it I noticed a typo in the docs. I figured since I was getting benefit from the package I ought to at least contribute that small fix back. At the same time I am trying out a new (to me) IDE and was curious how it would perform on a repo like this. It suggested the grammatical and spelling changes.

erikbryant commented 10 months ago

Along with go test ./... I have also just run go fmt ./... It found one change. I have added that to this PR.