You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@commons.apache.org by "mawiesne (via GitHub)" <gi...@apache.org> on 2025/08/14 07:33:50 UTC

[PR] Improve existing JavaDoc: highlight 'null' via {@code} [commons-compress]

mawiesne opened a new pull request, #686:
URL: https://github.com/apache/commons-compress/pull/686

   <!--
     Licensed to the Apache Software Foundation (ASF) under one
     or more contributor license agreements.  See the NOTICE file
     distributed with this work for additional information
     regarding copyright ownership.  The ASF licenses this file
     to you under the Apache License, Version 2.0 (the
     "License"); you may not use this file except in compliance
     with the License.  You may obtain a copy of the License at
   
       https://www.apache.org/licenses/LICENSE-2.0
   
     Unless required by applicable law or agreed to in writing,
     software distributed under the License is distributed on an
     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     KIND, either express or implied.  See the License for the
     specific language governing permissions and limitations
     under the License.
   -->
   
   What does this PR provide?
   -
   - Enhances existing classes' JavaDoc towards better readability by highlighting the `null` token in text.
   
   Tasks
   -
   Thanks for your contribution to [Apache Commons](https://commons.apache.org/)! Your help is appreciated!
   
   Before you push a pull request, review this list:
   
   - [x] Read the [contribution guidelines](CONTRIBUTING.md) for this project.
   - [x] Read the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) if you use Artificial Intelligence (AI).
   - [ ] I used AI to create any part of, or all of, this pull request.
   - [x] Run a successful build using the default [Maven](https://maven.apache.org/) goal with `mvn`; that's `mvn` on the command line by itself.
   - [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied. This may not always be possible, but it is a best-practice.
   - [x] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
   - [x] Each commit in the pull request should have a meaningful subject line and body. Note that a maintainer may squash commits during the merge process.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Improve existing JavaDoc: highlight 'null' via {@code} [commons-compress]

Posted by "mawiesne (via GitHub)" <gi...@apache.org>.
mawiesne commented on PR #686:
URL: https://github.com/apache/commons-compress/pull/686#issuecomment-3188889807

   > @mawiesne FYI: I'm not going to spend time reviewing a huge PR for a style change, especially when it also contains formatting changes; it takes too much time. If you want this PR reviewed, limit it to the actual change that matters, please.
   
   @garydgregory FYI: I'm not going to split this PR up, as the topic is clearly described and the time for providing quality enhancing PRs is limited on my side as well. The number of formatting changes is minimal and mostly related to characters per line limits / checks via PMD plugin.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Improve existing JavaDoc: highlight 'null' via {@code} [commons-compress]

Posted by "mawiesne (via GitHub)" <gi...@apache.org>.
mawiesne closed pull request #686: Improve existing JavaDoc: highlight 'null' via {@code}
URL: https://github.com/apache/commons-compress/pull/686


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@commons.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org