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

Minimal fixes to documentation of Context and Host #439

Closed
wants to merge 5 commits into from

Conversation

rrodewald
Copy link

  • Documented default value of unpackWARs attribute
  • Tagged all boolean values als code
  • Punctuation

Robert Rodewald added 2 commits August 4, 2021 11:23
- Documented default value of unpackWARs attribute
- Tagged all boolean values als code
- Punctuation
webapps/docs/config/host.xml Outdated Show resolved Hide resolved
@kkolinko
Copy link

kkolinko commented Aug 4, 2021

Reviewing...

  1. context.xml L187 s/docBase/<code>docBase</code>/ as well
  2. I am more used to "The default value is" rather than "The default is".
    I wonder what wording is better. Tomcat documentation uses both.

@rrodewald
Copy link
Author

Reviewing...

1. context.xml L187  `s/docBase/<code>docBase</code>/ `as well

2. I am more used to "The default value is" rather than "The default is".
   I wonder what wording is better. Tomcat documentation uses both.
  1. Done
  2. I am no native speaker so I do whatever I'm told to do...

@ChristopherSchultz
Copy link
Contributor

ChristopherSchultz commented Aug 4, 2021 via email

@rrodewald
Copy link
Author

If we want to standardize the wording for default values, I would suggest to open a new pull request for this, so that the main purpose of the present pull request (documentation of the default value of unpackWARs) can be considered as done.

Here is an incomplete list of wordings found:

  • Defaults to ...
  • Default [value] is ...
  • The default [value] is ...

@markt-asf
Copy link
Contributor

Thanks for the PR. +1 tp a new PR to make the default wording consistent.
Applied manually so I could a) add a change log entry and b) broadly maintain the line length limit of 80 chars for xml files.

@markt-asf markt-asf closed this Aug 17, 2021
@rrodewald rrodewald deleted the documentation-fixes branch September 6, 2021 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
5 participants