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

Abbreviate primitive/collection Java types in code snippets #429

Open
Chriscbr opened this issue Sep 7, 2021 · 2 comments
Open

Abbreviate primitive/collection Java types in code snippets #429

Chriscbr opened this issue Sep 7, 2021 · 2 comments

Comments

@Chriscbr
Copy link
Contributor

Chriscbr commented Sep 7, 2021

Minor enhancement.

It may improve the readability of the Java docs if we just show just the class name (String) for primitive types when the type is referenced within code snippets, but leave the the full Java import (java.lang.String) in the rest of the docs (outside of code snippets). For example:

CfnPublicRepositoryProps.builder()
//  .repositoryCatalogData(java.lang.Object)
//  .repositoryName(java.lang.String)
//  .repositoryPolicyText(java.lang.Object)
//  .tags(java.util.List<CfnTag>)
    .build();

should be:

CfnPublicRepositoryProps.builder()
//  .repositoryCatalogData(Object)
//  .repositoryName(String)
//  .repositoryPolicyText(Object)
//  .tags(List<CfnTag>)
    .build();
@github-actions
Copy link
Contributor

This issue is now marked as stale because it hasn't seen activity for a while. Add a comment or it will be closed soon. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

@github-actions github-actions bot added the stale label Jan 21, 2022
@github-actions
Copy link
Contributor

Closing this issue as it hasn't seen activity for a while. Please add a comment @mentioning a maintainer to reopen. If you wish to exclude this issue from being marked as stale, add the "backlog" label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant