Re: Class name formatting

Subject: Re: Class name formatting
From: Deanna Korth <deanna -dot- korth -at- gmail -dot- com>
To: Chris Despopoulos <despopoulos_chriss -at- yahoo -dot- com>
Date: Fri, 16 Oct 2020 08:33:21 -0500

Thank you, Chris.

Follow-up question: I need to write a wordier description. I don't want to
use the phrase "long description" because that's used for descriptions of
images. What do I call it, and what standard information should it include?

On Fri, Oct 16, 2020 at 4:36 AM Chris Despopoulos <
despopoulos_chriss -at- yahoo -dot- com> wrote:

> What formatting do you use when you document your relatives? Auntie
> Jane, in a plain language reference, would be "Your auntie, Jane." Same
> thing here. The class tmZone is a class for time zones. In other words,
> it is a time zone class.
> In this case, "time zone" is not a name. So you don't need any formatting
> at all. OTOH, I don't think I ever use that approach, unless there are
> many time zone classes, and I need to talk about them as a group. I always
> try to refer to a class or any other programming construct by its proper
> name, usually wrapped in <codeph>.
> cud
>
> From: Deanna Korth <deanna -dot- korth -at- gmail -dot- com>What formatting do you use
> when you document the plain language name of a
> class? For example, if the class name is tmZone, what formatting do you use
> when you're writing about the "time zone" class?
>
>
> ------------------------------
>
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> Visit TechWhirl for the latest on content technology, content strategy and
> content development | https://techwhirl.com
>
> ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
>
> You are currently subscribed to TECHWR-L as deanna -dot- korth -at- gmail -dot- com -dot-
>
> To unsubscribe send a blank email to
> techwr-l-leave -at- lists -dot- techwr-l -dot- com
>
>
> Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
> http://www.techwhirl.com/email-discussion-groups/ for more resources and
> info.
>
> Looking for articles on Technical Communications? Head over to our online
> magazine at http://techwhirl.com
>
> Looking for the archived Techwr-l email discussions? Search our public
> email archives @ http://techwr-l.com/archives
>
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Visit TechWhirl for the latest on content technology, content strategy and content development | https://techwhirl.com

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You are currently subscribed to TECHWR-L as archive -at- web -dot- techwr-l -dot- com -dot-

To unsubscribe send a blank email to
techwr-l-leave -at- lists -dot- techwr-l -dot- com


Send administrative questions to admin -at- techwr-l -dot- com -dot- Visit
http://www.techwhirl.com/email-discussion-groups/ for more resources and info.

Looking for articles on Technical Communications? Head over to our online magazine at http://techwhirl.com

Looking for the archived Techwr-l email discussions? Search our public email archives @ http://techwr-l.com/archives


References:
Re: Class name formatting: From: Chris Despopoulos

Previous by Author: Class name formatting
Next by Author: Re: Class name formatting
Previous by Thread: Re: Class name formatting
Next by Thread: LavaCon UX (Virtual) - Oct 23 - 28 - free pass


What this post helpful? Share it with friends and colleagues:


Sponsored Ads