Skip to content

Clean descriptions#266

Open
nielsbasjes wants to merge 2 commits intosunspec:masterfrom
nielsbasjes:CleanDescriptions
Open

Clean descriptions#266
nielsbasjes wants to merge 2 commits intosunspec:masterfrom
nielsbasjes:CleanDescriptions

Conversation

@nielsbasjes
Copy link
Copy Markdown
Contributor

My effort to cleanup the descriptions and make them consistent.

  • Remove references to the type it is.
  • Remove stray spaces.
  • Make all descriptions look more similar by always letting them end with a period.

@cla-bot cla-bot bot added the cla-signed label Jul 5, 2025
@bikeshedder
Copy link
Copy Markdown

Adding a . to a field name is not just a weird style but also wrong. Adding a . at the end only makes sense if it's an actual sentence. A good example here would be All SunSpec compliant devices must include this as the first model. where the full-stop (.) is currently missing.

If you really want to go the extra mile you could look into texts such as:

Control register. Normal operation is automatic. Operator can override the position by setting the ElCtl, AzCtl and enabling Manual operation. Entering calibration mode will revert to automatic operation after calibration is complete.

It should probably read something like:

This is a control register. Normal operation is automatic. Operator can override the position by setting the ElCtl, AzCtl and enabling Manual operation. Entering calibration mode will revert to automatic operation after calibration is complete.

@nielsbasjes
Copy link
Copy Markdown
Contributor Author

Ok, Ill fix that.

@nielsbasjes
Copy link
Copy Markdown
Contributor Author

I have dropped all the . changes and I'll check the sentence specific cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants