Glossary cleanup #45889

New Issue

gandalf3 · 2015-08-24T09:23:09+02:00

gandalf3 commented

2015-08-24 09:23:09 +02:00

Many of the definitions in the glossary are phrased inconsistently.
Perhaps a "template" style should be decided on for glossary entries to ensure consistency?

I've split this up into subtasks:

Define a style guide which specifies what makes a glossary entry and general writing style (#45893)
Remove glossary entries which shouldn't be in the glossary (#45894)
Make remaining entires conform to the guidelines (#45895)

Many of the definitions in the glossary are phrased inconsistently. Perhaps a "template" style should be decided on for glossary entries to ensure consistency? I've split this up into subtasks: 1. Define a style guide which specifies what makes a glossary entry and general writing style (#45893) 2. Remove glossary entries which shouldn't be in the glossary (#45894) 3. Make remaining entires conform to the guidelines (#45895)

gandalf3 commented

2015-08-24 09:23:09 +02:00

Changed status to: 'Open'

gandalf3 commented

2015-08-24 09:23:09 +02:00

Added subscriber: @gandalf3

Greg Zaal commented

2015-08-24 18:44:02 +02:00

Added subscriber: @GregZaal

Campbell Barton commented

2015-08-25 00:53:09 +02:00

Added subscriber: @ideasman42

Campbell Barton commented

2015-08-25 00:53:09 +02:00

Changed status from 'Open' to: 'Archived'

Campbell Barton closed this issue

2015-08-25 00:53:09 +02:00

Campbell Barton self-assigned this 2015-08-25 00:53:09 +02:00

Campbell Barton commented

2015-08-25 00:53:09 +02:00

@gandalf3, re "Many of the definitions in the glossary are phrased inconsistently."

This is too vague, I rather keep tasks here tangible - so its obvious when its resolved and we can close.

Please list which descriptions need edits.

@gandalf3, re *"Many of the definitions in the glossary are phrased inconsistently."* This is too vague, I rather keep tasks here tangible - so its obvious when its resolved and we can close. Please list which descriptions need edits.

gandalf3 commented

2015-08-25 02:23:22 +02:00

@ideasman42

There doesn't appear to be a standard or any particular style which is adhered to. This doesn't really make any of the writing styles wrong, just different from one another.
I think it would be good to decide on some template/guidelines to follow, then change all of them to match that.

For example, perhaps prepending "it's" or "is" should be discouraged. IMO this is redundant and adds noise right at the start of the definition.

Aside from this, there are also many many specific cases where something is very wrong/inaccurate/otherwise bad. For instance:

Collapse, Subdivision surface: Not sure these really need a glossary entry?

Topology: Duplicate entries, just needs cleanup

Actuator, Boolean, Constraint and many more: Rather awkward and in some cases misleading definitions

@ideasman42 There doesn't appear to be a standard or any particular style which is adhered to. This doesn't really make any of the writing styles *wrong*, just different from one another. I think it would be good to decide on some template/guidelines to follow, then change all of them to match that. For example, perhaps prepending "it's" or "is" should be discouraged. IMO this is redundant and adds noise right at the start of the definition. Aside from this, there are also many many specific cases where something is very wrong/inaccurate/otherwise bad. For instance: *Collapse*, *Subdivision surface*: Not sure these really need a glossary entry? *Topology*: Duplicate entries, just needs cleanup *Actuator*, *Boolean*, *Constraint* and many more: Rather awkward and in some cases misleading definitions

gandalf3 commented

2015-08-25 04:08:32 +02:00

Changed status from 'Archived' to: 'Open'

gandalf3 reopened this issue

2015-08-25 04:08:32 +02:00

gandalf3 commented

2015-08-25 04:08:32 +02:00

Splitting up into subtasks

Campbell Barton was unassigned by gandalf3

2015-08-25 04:09:14 +02:00

gandalf3 self-assigned this 2015-08-25 04:09:14 +02:00

gandalf3 removed their assignment 2015-08-25 04:20:43 +02:00