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

Improve JavaDoc for ConfigurableApplicationContext.refresh() #25380

Closed
MorrisZ opened this issue Jul 10, 2020 · 1 comment
Closed

Improve JavaDoc for ConfigurableApplicationContext.refresh() #25380

MorrisZ opened this issue Jul 10, 2020 · 1 comment
Assignees
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Milestone

Comments

@MorrisZ
Copy link

MorrisZ commented Jul 10, 2020

Affects: all versions

ConfigurableApplicationContext.refresh():

	/**
	 * Load or refresh the persistent representation of the configuration,
	 * which might an XML file, properties file, or relational database schema.
	 * <p>As this is a startup method, it should destroy already created singletons
	 * if it fails, to avoid dangling resources. In other words, after invocation
	 * of that method, either all or no singletons at all should be instantiated.
	 * @throws BeansException if the bean factory could not be initialized
	 * @throws IllegalStateException if already initialized and multiple refresh
	 * attempts are not supported
	 */
	void refresh() throws BeansException, IllegalStateException;

I found this "which might an XML file" weired, shouldn't it be "which might be an XML file" ?


@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Jul 10, 2020
@sbrannen sbrannen changed the title JavaDoc - fix grammar error on ConfigurableApplicationContext.refresh() Improve JavaDoc for ConfigurableApplicationContext.refresh() Jul 10, 2020
@sbrannen sbrannen self-assigned this Jul 10, 2020
@sbrannen sbrannen added in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Jul 10, 2020
@sbrannen sbrannen added this to the 5.2.8 milestone Jul 10, 2020
@sbrannen
Copy link
Member

Thanks for pointing out the grammatical error. I've revised the Javadoc in b769b73.

FelixFly pushed a commit to FelixFly/spring-framework that referenced this issue Aug 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
in: core Issues in core modules (aop, beans, core, context, expression) type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

3 participants