In the instructions for website developers (or website admins if they know what they're doing) we indicate that a placeholder value should be replaced with the actual customer reference when they call the code, but we've had support requests come through where people find this confusing.
Here is the opening paragraph of the instructions:
In all of the code examples below, replace [CustomerReference] with the customer reference provided to you when you signed up for the online booking system.
And then a code example looks like this:
Someone today (a website developer, no less) was requesting support because the system "wasn't working". I checked their site and he had included the square brackets in the function call, replacing the company reference inside it.
Thinking about it, I could see someone misreading the instructions and thinking it was an array, like:
But I hadn't expected them to leave the brackets in the string itself.
Is it enough just to put a note at the end of the instruction sentence:
In all of the code examples below, replace [CustomerReference] with the customer reference provided to you when you signed up for the online booking system (excluding the square brackets).
Or is there an altogether more universally understood way to indicate this?
I considered removing the brackets altogether, but I suspected it would be more difficult to pick out in the code samples where it should be replaced.