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 #104

Merged
merged 31 commits into from May 22, 2017
Merged
Show file tree
Hide file tree
Changes from 30 commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion CHANGELOG.md
Expand Up @@ -54,4 +54,4 @@ Parallel request routing for Blue Ocean. This will allow BlueOcean or any Jenkin
##### 1.243
Release date: April 29, 2016
* [PR 74](https://github.com/stapler/stapler/pull/74/files) -
BeanInfo doesn't work when there's assymetry in getter vs setter
BeanInfo doesn't work when there's asymmetry in getter vs setter
2 changes: 1 addition & 1 deletion core/example/WEB-INF/side-files/example/Track/index.jsp
Expand Up @@ -5,7 +5,7 @@
<hr>

<%--
because of the way we organize URL, going back to the parent CD objcet
because of the way we organize URL, going back to the parent CD object
is as easy as this
--%>
<a href="../..">back</a>
Expand Down
Expand Up @@ -5,7 +5,7 @@
<hr>

<%--
because of the way we organize URL, going back to the parent CD objcet
because of the way we organize URL, going back to the parent CD object
is as easy as this
--%>
<a href="../..">back</a>
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/kohsuke/stapler/AcceptHeader.java
Expand Up @@ -41,7 +41,7 @@ of this software and associated documentation files (the "Software"), to deal
* </p>
* <pre>
* HttpResponse doXyz(&#64;Header("Accept") AcceptHeader accept, ...) {
* swtich (accept.select("application/json","text/xml")) {
* switch (accept.select("application/json","text/xml")) {
* case "application/json":
* ...
* case "text/html":
Expand Down
Expand Up @@ -33,7 +33,7 @@ public Object onConvert(Type targetType, Class targetTypeErasure, Object jsonSou
* Called for each object conversion, after the actual subtype to instantiate is determined.
*
* @param actualType
* The type to instnatiate
* The type to instantiate
* @param json
* JSON object to be mapped to Java object.
* @return
Expand Down
Expand Up @@ -30,7 +30,7 @@
import static org.kohsuke.stapler.Stapler.escape;

/**
* Remebers the {@link Stapler#invoke(RequestImpl, ResponseImpl, Object)}
* Remembers the {@link Stapler#invoke(RequestImpl, ResponseImpl, Object)}
* evaluation traces.
*
* @author Kohsuke Kawaguchi
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/org/kohsuke/stapler/Facet.java
Expand Up @@ -99,9 +99,9 @@ public static <T> List<T> discoverExtensions(Class<T> type, ClassLoader... cls)
try {
r.add((T)c.newInstance());
} catch (InstantiationException e) {
LOGGER.log(Level.WARNING, "Failed to instanticate "+c,e);
LOGGER.log(Level.WARNING, "Failed to instantiate "+c,e);
} catch (IllegalAccessException e) {
LOGGER.log(Level.WARNING, "Failed to instanticate "+c,e);
LOGGER.log(Level.WARNING, "Failed to instantiate "+c,e);
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/kohsuke/stapler/MetaClass.java
Expand Up @@ -404,7 +404,7 @@ public String toString() {
}

/**
* Returns all the methods in the ancestory chain annotated with {@link PostConstruct}
* Returns all the methods in the ancestry chain annotated with {@link PostConstruct}
* from those defined in the derived type toward those defined in the base type.
*
* Normally invocation requires visiting the list in the reverse order.
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/kohsuke/stapler/RequestImpl.java
Expand Up @@ -87,7 +87,7 @@ public class RequestImpl extends HttpServletRequestWrapper implements StaplerReq
*/
public final TokenList tokens;
/**
* Ancesotr nodes traversed so far.
* Ancestor nodes traversed so far.
* This object is modified by {@link Stapler} as we parse through the URL.
*/
public final List<AncestorImpl> ancestors;
Expand Down
Expand Up @@ -42,7 +42,7 @@ public interface StaplerFallback {
* @return
* If null or {@code this} is returned, stapler behaves as if the object
* didn't implement this interface (which means the request processing
* failes with 404.)
* fails with 404.)
*/
Object getStaplerFallback();
}
Expand Up @@ -35,7 +35,7 @@
*
* <p>
* In override objects, {@link CancelRequestHandlingException} is an useful mechanism to programmatically
* inspect a request and then selecctively return the request back to the original object (that implements
* inspect a request and then selectively return the request back to the original object (that implements
* {@link StaplerOverridable}.
*
* @author Kohsuke Kawaguchi
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/org/kohsuke/stapler/export/Exported.java
Expand Up @@ -82,7 +82,7 @@
* object.
*
* <p>
* This flag can be used to selectively expand the subree to be
* This flag can be used to selectively expand the subtree to be
* returned to the client.
*/
boolean inline() default false;
Expand Down Expand Up @@ -126,7 +126,7 @@
* "[{name:"kohsuke", value:"abc"], ...}
*
* <p>
* The verboose form is useful/necessary when you use complex data structure as a key,
* The verbose form is useful/necessary when you use complex data structure as a key,
* or if the string representation of the key can contain letters that are unsafe in some flavours
* (such as XML, which prohibits a number of characters to be used as tag names.)
*
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/org/kohsuke/stapler/export/Model.java
Expand Up @@ -136,7 +136,7 @@ public boolean apply(@Nullable String name) {
/**
* Does a property exist strictly in this class or its ancestors?
*/
/*package*/ final Predicate<String> HAS_PROPERTY_NAME_IN_ANCESTORY = new Predicate<String>() {
/*package*/ final Predicate<String> HAS_PROPERTY_NAME_IN_ANCESTRY = new Predicate<String>() {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this is an API break

Copy link
Member

Choose a reason for hiding this comment

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

Not an API break since it is package-internal

@Override
public boolean apply(@Nullable String name) {
for (Model m=Model.this; m!=null; m=m.superModel)
Expand Down
Expand Up @@ -148,7 +148,7 @@ public void writeTo(Object object, TreePruner pruner, DataWriter writer) throws
}
throw e;
}
model.writeNestedObjectTo(d, new FilteringTreePruner(parent.HAS_PROPERTY_NAME_IN_ANCESTORY,child), writer);
model.writeNestedObjectTo(d, new FilteringTreePruner(parent.HAS_PROPERTY_NAME_IN_ANCESTRY,child), writer);
}
} else {
writer.name(name);
Expand Down
Expand Up @@ -529,7 +529,7 @@ public static Type getTypeArgument(Type type, int i) {
}

/**
* JDK 5.0 has a bug of createing {@link GenericArrayType} where it shouldn't.
* JDK 5.0 has a bug of creating {@link GenericArrayType} where it shouldn't.
* fix that manually to work around the problem.
*
* See bug 6202725.
Expand Down
Expand Up @@ -186,7 +186,7 @@ public static boolean isLetter (char c)
//
private static boolean isCompatibilityChar (char c)
{
// the numerous comparisions here seem unavoidable,
// the numerous comparisons here seem unavoidable,
// but the switch can reduce the number which must
// actually be executed.

Expand Down
Expand Up @@ -260,7 +260,7 @@ public void contextDestroyed(ServletContextEvent event) {
}

/**
* Called during the destructino of the web app to perform
* Called during the destruction of the web app to perform
* any clean up act on the application object.
*/
protected void cleanUp(T app) {}
Expand Down
Expand Up @@ -7,7 +7,7 @@
import java.util.Map;

/**
* Very simple multi-map implmentation.
* Very simple multi-map implementation.
*
* <p>
* We historically used Google Collections, but there have been multiple reports that
Expand Down
Expand Up @@ -4063,7 +4063,7 @@ var $continue = new Error('"throw $continue" is deprecated, use "return" instead
// further below, that map to the newer Element methods.
var Position = {
// set to true if needed, warning: firefox performance problems
// NOT neeeded for page scrolling, only if draggable contained in
// NOT needed for page scrolling, only if draggable contained in
// scrollable elements
includeScrollOffsets: false,

Expand Down
Expand Up @@ -81,7 +81,7 @@ public static class Sub extends Super {}


/**
* D.x() overries B.x()
* D.x() overrides B.x()
*/
@Test
public void overridingMethod() throws Exception {
Expand Down
6 changes: 3 additions & 3 deletions core/src/test/java/org/kohsuke/stapler/DataBindingTest.java
Expand Up @@ -192,12 +192,12 @@ public RawBinding(JSONObject x, JSONArray y) {
public void testRaw() {
RawBinding r = bind("{x:{a:true,b:1},y:[1,2,3]}", RawBinding.class);

// array coersion on y
// array coercion on y
RawBinding r2 = bind("{x:{a:true,b:1},y:{p:true}}", RawBinding.class);
JSONObject o = (JSONObject)r2.y.get(0);
assertTrue(o.getBoolean("p"));

// array coersion on y
// array coercion on y
RawBinding r3 = bind("{x:{a:true,b:1},y:true}", RawBinding.class);
assertTrue((Boolean)r3.y.get(0));
}
Expand Down Expand Up @@ -406,7 +406,7 @@ public void setItems(Collection<Integer> v) {


/**
* Subyping and overriding a setter shouldn't hide it.
* Subtyping and overriding a setter shouldn't hide it.
*/
public void testDerivedProperty() {
DerivedProperty r = bind("{items:[1,3,5]}",DerivedProperty.class);
Expand Down
Expand Up @@ -45,7 +45,7 @@
public class RequestImplTest {

@Test
public void test_mutipart_formdata() throws IOException, ServletException {
public void test_multipart_formdata() throws IOException, ServletException {
final Stapler stapler = new Stapler();
final byte[] buf = generateMultipartData();
final ByteArrayInputStream is = new ByteArrayInputStream(buf);
Expand Down
Expand Up @@ -39,7 +39,7 @@ public class ModelTest {
ModelBuilder builder = new ModelBuilder();

@Test // JENKINS-26775
public void sytheticMethodShouldNotBeExported() {
public void syntheticMethodShouldNotBeExported() {
Model<Impl> model = builder.get(Impl.class);
assertEquals("Redundant properties discovered: " + model.getProperties(), 1, model.getProperties().size());
}
Expand Down
Expand Up @@ -545,7 +545,7 @@ public void run(JellyContext context, XMLOutput output) {
* {@link GroovyClosureScript} so that it can use this builder as the delegation target.
*
* <p>
* This method instanciates the class (if not done so already for this request),
* This method instantiates the class (if not done so already for this request),
* and return it.
*/
public Object taglib(Class type) throws IllegalAccessException, InstantiationException, IOException, SAXException {
Expand Down
Expand Up @@ -126,7 +126,7 @@ private void processGSstring(Reader reader, StringWriter sw) throws IOException
}

/**
* Closes the currently open write and writes out the following text as a GString expression until it reaches an end %>.
* Closes the currently open write and writes out the following text as a GSstring expression until it reaches an end %>.
Copy link
Member

Choose a reason for hiding this comment

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

No, this was correct before; revert (or, better, switch to @link).

*
* @param reader a reader for the template text
* @param sw a StringWriter to write expression content
Expand Down
Expand Up @@ -28,7 +28,7 @@
import org.jvnet.maven.jellydoc.annotation.Required;

/**
* DTD-like expression that specifies the consraints on attribute appearances.
* DTD-like expression that specifies the constraints on attribute appearances.
*
* <p>
* This tag should be placed right inside {@code <st:documentation>}
Expand Down
Expand Up @@ -121,7 +121,7 @@ private Script load(String name) throws JellyException {

private Script load(String name, ClassLoader classLoader) throws JellyException {
Script script;
// prefer 'foo.jellytag' but for backward compatibility, support the plain .jelly extention as well.
// prefer 'foo.jellytag' but for backward compatibility, support the plain .jelly extension as well.
URL res = classLoader.getResource(basePath + '/' + name + ".jellytag");
if (res==null)
res = classLoader.getResource(basePath + '/' + name + ".jelly");
Expand Down
Expand Up @@ -40,7 +40,7 @@
* internationalized text.
*
* <p>
* The "(arg1,...)" portion is optional and can be ommitted. Each argument
* The "(arg1,...)" portion is optional and can be omitted. Each argument
* is assumed to be a parenthesis-balanced expression and passed to
* {@link JellyClassLoaderTearOff#EXPRESSION_FACTORY} to be parsed.
*
Expand Down
Expand Up @@ -73,7 +73,7 @@ protected Script resolveDefinition(JellyContext context) throws JellyTagExceptio
WebApp webApp = WebApp.getCurrent();
MetaClass c = webApp.getMetaClass(it instanceof Class ? Klass.java((Class)it): webApp.getKlass(it));
// prefer 'foo.jellytag' to avoid tags from showing up as views,
// but for backward compatibility, support the plain .jelly extention as well.
// but for backward compatibility, support the plain .jelly extension as well.
Script tag = c.loadTearOff(JellyClassTearOff.class).findScript(tagName+".jellytag");
if (tag==null)
tag = c.loadTearOff(JellyClassTearOff.class).findScript(tagName+".jelly");
Expand Down
Expand Up @@ -37,7 +37,7 @@ public Script compile() throws JellyException {
public abstract void run(JellyContext context, XMLOutput output) throws JellyTagException;

/**
* Invokes other Jelly tag libaries.
* Invokes other Jelly tag libraries.
*/
public void invokeTaglib(final IJRubyContext rcon, JellyContext context, XMLOutput output, String uri, String localName, Map<RubySymbol,?> attributes, final RubyProc proc) throws JellyException {
TagScript tagScript = createTagScript(context, uri, localName);
Expand Down
2 changes: 1 addition & 1 deletion src/site/resources/compression.html
Expand Up @@ -22,7 +22,7 @@ <h1>Using compression from Jelly view</h1>
<p>
If your view script produces text content, and if you'd like to compress the stream, put <tt>&lt;st:compress xmlns:st="jelly:stapler"></tt> as the root element of your view, like this:
<pre class=code><xmp>
<st:compres xmlns:st="jelly:stapler" ... other ns decls ...>
<st:compress xmlns:st="jelly:stapler" ... other ns decls ...>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This seem to be a bug fix afaict

Copy link
Member

Choose a reason for hiding this comment

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

It is

Copy link
Member

Choose a reason for hiding this comment

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

Huh? This is just documentation, not production code.

<html>
<head>
...
Expand Down
2 changes: 1 addition & 1 deletion src/site/resources/getting-started.html
Expand Up @@ -33,7 +33,7 @@ <h3>Setting up your web app</h3>

<h3>Registering the root object</h3>
<p>
Stapler needs to know the root object of your application. It does that by <tt>SerlvetContext.getAttribute("app")</tt>, so your application needs to set the root object into a ServletContext. The easiest to do that is to write a <a href="http://java.sun.com/j2ee/1.4/docs/api/javax/servlet/ServletContextListener.html"><tt>ServletContextListener</tt></a> and use the helper method from <tt>Stapler</tt>.
Stapler needs to know the root object of your application. It does that by <tt>ServletContext.getAttribute("app")</tt>, so your application needs to set the root object into a ServletContext. The easiest to do that is to write a <a href="http://java.sun.com/j2ee/1.4/docs/api/javax/servlet/ServletContextListener.html"><tt>ServletContextListener</tt></a> and use the helper method from <tt>Stapler</tt>.
<p>
Specifically, you write the following class:
<pre class=code><xmp
Expand Down
4 changes: 2 additions & 2 deletions src/site/resources/jelly-taglib-ref.html
Expand Up @@ -85,7 +85,7 @@


<p>
To couner this effect, this class temporarily restores the original "attrs"
To counter this effect, this class temporarily restores the original "attrs"
when the body is evaluated. This makes the name resolution of 'attrs' work
like what programmers normally expect.

Expand Down Expand Up @@ -317,7 +317,7 @@


<p>
To couner this effect, this class temporarily restores the original "attrs"
To counter this effect, this class temporarily restores the original "attrs"
when the body is evaluated. This makes the name resolution of 'attrs' work
like what programmers normally expect.

Expand Down
2 changes: 1 addition & 1 deletion src/site/resources/what-is.html
Expand Up @@ -15,7 +15,7 @@
</div>

<p>
The left half shows your code. OOP lets you model those concepts straight-forwadly into classes that refer to each other. Through reflection, Stapler assigns URLs to your application objects. The root of your application object gets the root URL <tt>/</tt>. The object you can access with <tt>root.getProject("stapler")</tt> would be assigned to the URL <tt>/project/stapler</tt>. In this way, your object model directly turns into the URL hierarchy, as partially shown in purple arrows.
The left half shows your code. OOP lets you model those concepts straight-forwardly into classes that refer to each other. Through reflection, Stapler assigns URLs to your application objects. The root of your application object gets the root URL <tt>/</tt>. The object you can access with <tt>root.getProject("stapler")</tt> would be assigned to the URL <tt>/project/stapler</tt>. In this way, your object model directly turns into the URL hierarchy, as partially shown in purple arrows.

<h3>JSPs and servlets</h3>
<p>
Expand Down