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

Americanize spellings and fix typos #390

Merged
merged 6 commits into from
Jul 2, 2013
Merged

Conversation

mtbc
Copy link
Member

@mtbc mtbc commented Jun 7, 2013

No description provided.

@jburel
Copy link
Member

jburel commented Jun 10, 2013

Since you are editing some files, few other corrections should be done.
e.g.

Insight/Architecture.txt

Remove ? e.g. Viewer ?/ Introduce when converting the doc

Web/WritingViews.txt
ie should be i.e.
it's should be it is

..?...js code
to be fixed

editor/editor-getting-started.tx
it's => it is

@jburel helped me to find these issues
@mtbc
Copy link
Member Author

mtbc commented Jun 11, 2013

filed https://trac.openmicroscopy.org.uk/ome/ticket/11097 about JS code pointer

@jburel
Copy link
Member

jburel commented Jun 12, 2013

@mtbc: Comment for AdvancedClientDevelopment.txt

what's happening
all the costs that that entails
we'll discuss below.
we'll get to below

a hierarchy of types which wraps the primitives: Types is the subject in that case. so should be wrap
etc should have a . after 
|OmeroModel| . The OMERO:  extra space.

there's an OMERO-generated class

Because of the
interconnectedness of the |OmeroModel| , extra space

there weren't some way to "snip-off" sections.
In the Python case, we've also tried to

(It should be
noted, however, that the accessors will perform marginally faster) Missing . at the end

Omero client configuration should be OMERO

registers an
ObjectFactory? Remove ?

collection of all services provided by OMERO are known Subject is collection so it should be is known
the client won't suffer any consequences
so won't be repeated here.

See README for convention about list (End of the README file)
-  how to detect client/server version mismatches
-  how to make asynchronous methods
-  how to use client callbacks
-  how to make use of your own ``ObjectFactory``


updating a ``WellSample`` instances should be instance

There's the Ice-generated abstract class

See README for convention about list (End of the README file)
 - omero.model.Details
 -  a subclass of omero.model.IObject
 -  a subclass of omero.RType
 -  a sequence (see discussion above)

one doesn't want to use
   receive a warning.

See README for convention about list (End of the README file)

-  more examples of working with the |OmeroModel| 
-  examples of all services
-  security and ownership
-  performance

@jburel
Copy link
Member

jburel commented Jun 12, 2013

comment for Insight / Architecture.txt

initialisation =>initialization

@jburel
Copy link
Member

jburel commented Jun 12, 2013

Insight / TaskBar.txt

we've created so far.

@mtbc
Copy link
Member Author

mtbc commented Jun 14, 2013

I think the list punctuation is okay and fits in with the guidelines.

    @jburel helped me to find these issues
@jburel
Copy link
Member

jburel commented Jun 14, 2013

@mtbc: I have not yet finished to review the doc. So probably more to come

@jburel
Copy link
Member

jburel commented Jun 14, 2013

june-2012.txt
List to be checked Capital letter but no dot

The OME Model (i.e. the other XSD files) have => should be has

@jburel
Copy link
Member

jburel commented Jun 14, 2013

Insight/DirectoryContents.txt
To be removed.

  • legal: Terms and conditions under which the various artifacts in
    this repository are released. A README file specifies which license
    applies to which artifact.
  • LIB: All library files required by the application. Its test
    sub-dir contains additional libraries required by the test code.
  • CodeTemplate: This file describes the coding style that all
    source files must conform to.

@jburel
Copy link
Member

jburel commented Jun 14, 2013

HowTo/BuildAgent.txt

Write Agent code => Missing dot
Let's create

Missing dot

  • Create a myBrowser package in the agents.events package
  • Create a BrowseImage event in the myBrowser package

Open the container.xml located in the config folder (see
:doc:/developers/Insight/DirectoryContents)

@jburel
Copy link
Member

jburel commented Jun 14, 2013

HowTo/BuildAgentView.txt

Let's go

@jburel
Copy link
Member

jburel commented Jun 14, 2013

Insight/HowTo/RetrieveData.txt

so we don't have to wait.
Description wasn't available.

@jburel
Copy link
Member

jburel commented Jun 14, 2013

Insight/ImplementationView.txt

Organisation => Organization

@jburel
Copy link
Member

jburel commented Jun 14, 2013

omero/developers/Model.txt
Mutable, annotated, global => missing dot
some of the methods will return null => use code quote around null
the getClass() method return => should be returns
(if no data is stored, the map is null).=> use code quote around null

transient
the entity has been created ("new Image()") and not yet shown to the
backend => missing dot

users don't simultaneously edit the same object. => do not
OptimisticLockException? => remove ? add code quote
references to IObject instances from
different return graphs will start to intermingle => Missing word after graphs. I will add that or which
multi-user settings => multi-users
the multi-user setting
ClientSession? => ? to be remove and add code quote
the sizeOf method => add code quote and replace by sizeOfXXX
Versioning/Locking? => ? to be remove and add code quote

  • ObjectFactory? => ? to be remove and add code quote

@jburel
Copy link
Member

jburel commented Jun 14, 2013

@mtbc: enough for now, will do a bit more later

@mtbc
Copy link
Member Author

mtbc commented Jun 14, 2013

Maybe this PR should be on hold until after Paris anyway?

@jburel
Copy link
Member

jburel commented Jun 14, 2013

agree

@@ -1671,8 +1670,8 @@ The following code has a resource leak:
s = c.createSession()
sys.exit(0)

Though the client won't suffer any consequences, this snippet leaves a
:doc:`session </developers/Server/Sessions>` open on the server.
Though the client will not suffer any consequences, this snippet leaves
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be 'Although'

@hflynn
Copy link
Member

hflynn commented Jun 25, 2013

Thanks for doing this Mark - I swear the 's breed while my back is turned ;)

mostly suggested by @jburel and @hflynn
@mtbc
Copy link
Member Author

mtbc commented Jul 1, 2013

Some of the larger lists, as in june-2012.txt, intimidated me in trying to figure out which points counted as full sentences and how to fix lists with various kinds of element and whatnot, so I didn't fix those; perhaps they can be wrapped into some larger documentation review separate from this expanding PR.

@hflynn
Copy link
Member

hflynn commented Jul 1, 2013

I'm inclined to suggest we leave this here, Mark - these PRs tend to just keep growing otherwise!

@hflynn
Copy link
Member

hflynn commented Jul 1, 2013

Good to merge once final correction has been made.

@mtbc
Copy link
Member Author

mtbc commented Jul 2, 2013

Done.

@hflynn
Copy link
Member

hflynn commented Jul 2, 2013

Good to merge.

@mtbc
Copy link
Member Author

mtbc commented Jul 2, 2013

Sorry, noticed one last glaring thing. (-:

@hflynn
Copy link
Member

hflynn commented Jul 2, 2013

All good now.

jburel added a commit that referenced this pull request Jul 2, 2013
Americanize spellings and fix typos
@jburel jburel merged commit ce1aa55 into ome:dev_4_4 Jul 2, 2013
@mtbc mtbc deleted the americanize-spellings branch July 2, 2013 12:21
@jburel
Copy link
Member

jburel commented Sep 9, 2013

--rebased-to #406

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

Successfully merging this pull request may close these issues.

None yet

3 participants