zrhoffman opened a new issue #4295: tc GoDoc starts with sentence about the 
enum package
URL: https://github.com/apache/trafficcontrol/issues/4295
 
 
   <!--
   ************ STOP!! ************
   If this issue identifies a security vulnerability, DO NOT submit it! 
Instead, contact
   the Apache Software Foundation Security Team at 
secur...@trafficcontrol.apache.org and follow the
   guidelines at https://www.apache.org/security/ regarding vulnerability 
disclosure.
   -->
   
   <!--
   - For *SUPPORT QUESTIONS*, use the
   [Traffic Control slack channels](https://traffic-control-cdn.slack.com) or 
[Traffic Control mailing 
lists](http://trafficcontrol.apache.org/mailing_lists/).
   - Before submitting, please **SEARCH GITHUB** for a similar issue or PR. -->
   
   ## I'm submitting a ...
   <!-- (check all that apply with "[x]") -->
   <!--- security vulnerability (STOP!! - see above)-->
   - [x] bug report
   - [ ] new feature / enhancement request
   - [ ] improvement request (usability, performance, tech debt, etc.)
   - [ ] other <!--(Please do not submit support requests here - see above)-->
   
   ## Traffic Control components affected ...
   <!-- (check all that apply with "[x]") -->
   - [ ] CDN in a Box
   - [x] Documentation
   - [ ] Grove
   - [ ] Traffic Control Client
   - [ ] Traffic Monitor
   - [ ] Traffic Ops
   - [ ] Traffic Ops ORT
   - [ ] Traffic Portal
   - [ ] Traffic Router
   - [ ] Traffic Stats
   - [ ] Traffic Vault
   - [ ] unknown
   
   ## Current behavior:
   <!-- Describe how the bug manifests / how the current features are 
insufficient. -->
   If you visit https://godoc.org/github.com/apache/trafficcontrol/lib/go-tc, 
the GoDoc for the `tc` package will start with the following sentence:
   > [Package enum contains enumerations and strongly typed 
names.](https://github.com/apache/trafficcontrol/blob/RELEASE-4.0.0-RC1/lib/go-tc/enum.go#L1)
   
   ## Expected / new behavior:
   <!-- Describe what the behavior would be without the bug / how the feature 
would improve Traffic Control -->
   The `tc` GoDoc should only describe itself as the `tc` package.
   
   ## Minimal reproduction of the problem with instructions:
   <!--
   If the current behavior is a bug or you can illustrate your feature request 
better with an example,
   please provide the *STEPS TO REPRODUCE* and include the applicable TC 
version.
   -->
   1. Run these commands:
       ```shell
       go get -u golang.org/x/tools/cmd/godoc
       godoc -http=:6060
       ```
   1. In your browser, navigate to 
http://localhost:6060/pkg/github.com/apache/trafficcontrol/lib/go-tc/
   
   1. Check the first sentence of the Overview section
   
   ## Anything else:
   <!-- e.g. stacktraces, related issues, suggestions how to fix -->
   `enum.go` should remain part of the `tc` package. See 
https://github.com/apache/trafficcontrol/pull/4293#issuecomment-574356841 for 
discussion.
   
   <!--
   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
   
       http://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.
   -->

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


With regards,
Apache Git Services

Reply via email to