Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Spelling [and other cleanup] issues omnibus #117

Open
2 tasks done
LisaAlmarode opened this issue Feb 24, 2023 · 9 comments
Open
2 tasks done

Spelling [and other cleanup] issues omnibus #117

LisaAlmarode opened this issue Feb 24, 2023 · 9 comments
Assignees

Comments

@LisaAlmarode
Copy link
Member

LisaAlmarode commented Feb 24, 2023

  • AbstractFileReference class comment includes duplucation
  • a few uses of possessive it's (should be its) in comments for class Path
    The selector #* was chosen for it's visual similarity to $.
    Answer an absolute path with aString as it's sole segment. The selector

(Misspelling also in FsUUID but I believe that class will be subsumed.)

@kurtkilpela
Copy link
Member

FsUUID is now gone so any issues there can be ignored.

@kurtkilpela
Copy link
Member

63476c8 fixes current list of known issues. Leaving ticket open as a place to use for further issues.

@LisaAlmarode
Copy link
Member Author

I can't find a separate bug, but this seems a reasonable place to complain about bad method categories:

as yet unclassified
AbsolutePath class>>addEmptyElementTo:
AbsolutePath class>>from:delimiter:

@LisaAlmarode LisaAlmarode changed the title Spelling issues omnibus Spelling [and other cleanup] issues omnibus Mar 9, 2023
@LisaAlmarode
Copy link
Member Author

FilePermissionDenied doesn't have a class comment.

@LisaAlmarode
Copy link
Member Author

Class comments that needs update:

FileDoesNotExistException,
Some comments in are not correct for GemStone; references to Files and UIManager.

FileLocator
Examples in invoke image and vmBinary, which fail

ZnCharacterEncoder
references TextConverter,
#encodeString: #decodeBytes: which don't seem to exist
"contrary to older encoders" is not appropriate for this context
excessively creative spelling of instanciating

Zn8BITEncoder
hardcoded link to a tag the 3.6 topaz html guide.
We might want a techtip on encoding and create a pretty link to avoid this link aging out.

@kurtkilpela
Copy link
Member

ZnCharacterEncoder #encodeString: #decodeBytes: which don't seem to exist

--> These are implemented between ZnCharacterEncoder and subclasses.

@kurtkilpela
Copy link
Member

The Zn8BITEncoder comment is very likely to get out of date. We can either do a techtip as you suggest, or be a little less helpful and just say, see "'Handling text outside the ASCII range' in the topaz manual" and avoid providing a link.

@kurtkilpela
Copy link
Member

For now, I've done the less helpful thing and removed the link and section comment.

@kurtkilpela
Copy link
Member

Remaining issues have been resolved in d348449.

Leaving this ticket open for the moment as additional issues may be found, or the handling of the topaz manual link may not be ideal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants