You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beam.apache.org by "Alexey Romanenko (JIRA)" <ji...@apache.org> on 2018/01/26 09:49:00 UTC

[jira] [Updated] (BEAM-3539) BigtableIO.Write javadoc of some methods is incorrect

     [ https://issues.apache.org/jira/browse/BEAM-3539?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Alexey Romanenko updated BEAM-3539:
-----------------------------------
    Description: 
Some methods in BigtableIO.Write have wrong javadoc which says that it returns new instance of BigtableIO.Read.

For example:

{{/**}}
{{ * Returns a new \{@link BigtableIO.Read} that will write into the Cloud Bigtable project}}
{{ * indicated by given parameter, requires \{@link #withInstanceId}}}
{{ * to be called to determine the instance.}}
{{ *}}
{{ * <p>Does not modify this object.}}
{{ */}}

{{}} {{public Write withProjectId(ValueProvider<String> projectId) {}}{{...}}{{}}}{{}}

 

Actually, it returns new BigtableIO.Write

  was:
Some methods in BigtableIO.Write have wrong javadoc which says that it returns new instance of BigtableIO.Read.

For example:

{{/**}}
{{ * Returns a new *{@link BigtableIO.Read}* that will write into the Cloud Bigtable project}}
{{ * indicated by given parameter, requires \{@link #withInstanceId}}}
{{ * to be called to determine the instance.}}
{{ *}}
{{ * <p>Does not modify this object.}}
{{ */}}
{{public Write withProjectId(ValueProvider<String> projectId) {}}{{...}}{{}}}{{}}

 

Actually, it returns new BigtableIO.Write


> BigtableIO.Write javadoc of some methods is incorrect
> -----------------------------------------------------
>
>                 Key: BEAM-3539
>                 URL: https://issues.apache.org/jira/browse/BEAM-3539
>             Project: Beam
>          Issue Type: Improvement
>          Components: sdk-java-gcp
>    Affects Versions: 2.2.0
>            Reporter: Alexey Romanenko
>            Priority: Trivial
>             Fix For: 2.3.0
>
>
> Some methods in BigtableIO.Write have wrong javadoc which says that it returns new instance of BigtableIO.Read.
> For example:
> {{/**}}
> {{ * Returns a new \{@link BigtableIO.Read} that will write into the Cloud Bigtable project}}
> {{ * indicated by given parameter, requires \{@link #withInstanceId}}}
> {{ * to be called to determine the instance.}}
> {{ *}}
> {{ * <p>Does not modify this object.}}
> {{ */}}
> {{}} {{public Write withProjectId(ValueProvider<String> projectId) {}}{{...}}{{}}}{{}}
>  
> Actually, it returns new BigtableIO.Write



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)