You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "ASF GitHub Bot (Jira)" <ji...@apache.org> on 2022/01/27 18:41:00 UTC

[jira] [Work logged] (AVRO-3328) Documentation update for CodeGen class

     [ https://issues.apache.org/jira/browse/AVRO-3328?focusedWorklogId=716593&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-716593 ]

ASF GitHub Bot logged work on AVRO-3328:
----------------------------------------

                Author: ASF GitHub Bot
            Created on: 27/Jan/22 18:40
            Start Date: 27/Jan/22 18:40
    Worklog Time Spent: 10m 
      Work Description: KyleSchoonover opened a new pull request #1479:
URL: https://github.com/apache/avro/pull/1479


   Make sure you have checked _all_ steps below.
   
   ### Jira
   
   - [ ] My PR addresses the following [Avro Jira](https://issues.apache.org/jira/browse/AVRO/) issues and references them in the PR title. For example, "AVRO-1234: My Avro PR"
     - https://issues.apache.org/jira/browse/AVRO-3328
   
   ### Tests
   
   - [ ] My PR  does not need testing for this extremely good reason: XML Documentation update
   
   ### Commits
   
   - [ ] My commits all reference Jira issues in their subject lines. In addition, my commits follow the guidelines from "[How to write a good git commit message](https://chris.beams.io/posts/git-commit/)":
     1. Subject is separated from body by a blank line
     1. Subject is limited to 50 characters (not including Jira issue reference)
     1. Subject does not end with a period
     1. Subject uses the imperative mood ("add", not "adding")
     1. Body wraps at 72 characters
     1. Body explains "what" and "why", not "how"
   
   ### Documentation
   
   - [ ] In case of new functionality, my PR adds documentation that describes how to use it.
     - All the public functions and the classes in the PR contain Javadoc that explain what it does
   


-- 
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: dev-unsubscribe@avro.apache.org

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


Issue Time Tracking
-------------------

            Worklog Id:     (was: 716593)
    Remaining Estimate: 0h
            Time Spent: 10m

> Documentation update for CodeGen class
> --------------------------------------
>
>                 Key: AVRO-3328
>                 URL: https://issues.apache.org/jira/browse/AVRO-3328
>             Project: Apache Avro
>          Issue Type: Improvement
>          Components: csharp
>    Affects Versions: 1.11.1
>            Reporter: Kyle Schoonover
>            Priority: Minor
>          Time Spent: 10m
>  Remaining Estimate: 0h
>
> Update the class documentation to meet the style standards for documentation in C#.
>  
> Reference: [Recommended XML documentation tags for a class and its members | Microsoft Docs|https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags]



--
This message was sent by Atlassian Jira
(v8.20.1#820001)