Problem-specifications: config.json: topics capitalization?

Created on 2 Jun 2017  路  7Comments  路  Source: exercism/problem-specifications

Doing some config.json updates on the go track and have been taking topics off the TOPICS.txt list where they are capitalized. Looking at the issue (common in other tracks too) that kicked off the introduction of topics the example is lowercase. It seems to have opened up an inconsistency of implementation across the tracks:

Looking at other some repos that have topics in their config.json, its mixed between lowercase (ex. dlang, factor, python) and capitalized (ex. go, scala, swift).

My question is: does the capitalization matter? Should we pick one and stick with it? If so which one?

I don't think capitalization matters much but I think consistency does. We should probably pick one and stick with it. If we end up going lowercase TOPICS.txt should be updated to reflect it.

Most helpful comment

I think having one format would not bring huge benefits, but it is nice to be consistent. The actual chosen capitalization doesn't really matter much to me, but lower case seems to be a sensible approach.

All 7 comments

My opinions (strength of opinion):

  • Topics should be case insensitive. (strong)
  • TOPICS.txt should retain current capitalization. (weak)
  • Tracks can choose themselves whether to capitalize or not. (strong)
  • Cross-track case consistency is not important. (medium)

I favor lower case for the topics in every context.

I think having one format would not bring huge benefits, but it is nice to be consistent. The actual chosen capitalization doesn't really matter much to me, but lower case seems to be a sensible approach.

People are leaning towards lower?

I'd lean towards lower also.

I like how @Insti exposed his opinions, so I'll copy the format:

  • Topics should be case insensitive. (strong)
  • TOPICS.txt should retain current capitalization. (weak)
  • Tracks can choose themselves whether to capitalize or not. (weak)
  • Cross-track case consistency is important. (strong). I'm sorry, but I disagree with @Insti and @ErikSchierboom in this point. I would like to see exactly the same topics (ignoring case) across tracks.
  • Tracks should keep punctuation and whitespace (strong): For example, if TOPICS.txt says Control-flow (loops), tracks should use: control-flow (loops) or Control-Flow (Loops) or even ConTroL-fLow (lOOps) but never control_flow_loops

It looks like https://github.com/exercism/discussions/issues/167 is going to make this issue moot. Will close. Discussion should continue there.

Edit: Linked to correct repository - Insti

Was this page helpful?
0 / 5 - 0 ratings

Related issues

budmc29 picture budmc29  路  3Comments

kytrinyx picture kytrinyx  路  5Comments

Mavelous picture Mavelous  路  4Comments

petertseng picture petertseng  路  5Comments

kytrinyx picture kytrinyx  路  4Comments