openrewrite / openrewrite/rewrite

Several recipe names and descriptions use `Type#method()` syntax

Open
#3,664 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug documentation
Dominant language
Java
Stars
3.7k
Forks
570
Avg merge
13h 12m
Merged PRs (30d)
261

Description

Most recipes use the Type.method() syntax in their name and description. However, a minority contains Javadoc-like syntax using hash with Type#method() instead. I'm not sure if this worked at any time for the documentation generation, but in the tool itself (e.g. via maven plugin) the syntax with dot seems more readable for end users.

Example: https://docs.openrewrite.org/recipes/java/security/usefilescreatetempdirectory

Any opinion on how to normalize these? The issue affects multiple repositories.

Are you interested in contributing a fix to OpenRewrite?

Yes, but someone with authority needs to decide on which way to go. :)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the example recipe page at docs.openrewrite.org/recipes/java/security/usefilescreatetempdirectory and compare recipe names and descriptions across the affected repositories. First resolve whether dot syntax is the desired convention, then identify all hash-style occurrences and normalize them consistently; no specific files or tests are named in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.