jettro / jettro/c3-angular-directive

rename ChartController

Open
#122 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
201
Forks
96
PR merge metrics
No merged PRs in 30d

Description

I suggest renaming the internal controller to something more specific - e.g c3ChartController.

I was testing c3-angular for the first time and so I used the generic ChartController name without realising it was already being used by c3-angular. This caused a naming conflict and the whole app fell over with very little helpful errors (i.e. angular didn't say there was any namespace conflict, just that a bunch of functions weren't found). It wasn't until I started digging in the source file and API that I realised the name conflict was to blame.

Given that people are likely to use generic names like this in their apps, I would strongly suggest you use a much more explicit name for the internal controller - or make it much clearer in the documentation.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.