minor touchups to comments

This commit is contained in:
ryanfkeepers 2023-08-11 16:32:06 -06:00
parent f504970adf
commit b7867317c1
2 changed files with 5 additions and 4 deletions

View File

@ -27,7 +27,7 @@ type Builder struct {
elements Elements elements Elements
} }
// Append creates a copy of this Builder and adds the given elements them to the // Append creates a copy of this Builder and adds the given elements to the
// end of the new Builder. Elements are added in the order they are passed. // end of the new Builder. Elements are added in the order they are passed.
func (pb Builder) Append(elements ...string) *Builder { func (pb Builder) Append(elements ...string) *Builder {
res := &Builder{elements: make([]string, len(pb.elements))} res := &Builder{elements: make([]string, len(pb.elements))}
@ -323,6 +323,7 @@ func (pb Builder) ToDataLayerPath(
}, nil }, nil
} }
// TODO: remove this. https://github.com/alcionai/corso/issues/4025
func (pb Builder) ToDataLayerExchangePathForCategory( func (pb Builder) ToDataLayerExchangePathForCategory(
tenant, user string, tenant, user string,
category CategoryType, category CategoryType,
@ -331,6 +332,7 @@ func (pb Builder) ToDataLayerExchangePathForCategory(
return pb.ToDataLayerPath(tenant, user, ExchangeService, category, isItem) return pb.ToDataLayerPath(tenant, user, ExchangeService, category, isItem)
} }
// TODO: remove this. https://github.com/alcionai/corso/issues/4025
func (pb Builder) ToDataLayerOneDrivePath( func (pb Builder) ToDataLayerOneDrivePath(
tenant, user string, tenant, user string,
isItem bool, isItem bool,
@ -338,6 +340,7 @@ func (pb Builder) ToDataLayerOneDrivePath(
return pb.ToDataLayerPath(tenant, user, OneDriveService, FilesCategory, isItem) return pb.ToDataLayerPath(tenant, user, OneDriveService, FilesCategory, isItem)
} }
// TODO: remove this. https://github.com/alcionai/corso/issues/4025
func (pb Builder) ToDataLayerSharePointPath( func (pb Builder) ToDataLayerSharePointPath(
tenant, site string, tenant, site string,
category CategoryType, category CategoryType,
@ -363,8 +366,7 @@ func (pb Builder) Format(fs fmt.State, _ rune) {
fmt.Fprint(fs, pb.Conceal()) fmt.Fprint(fs, pb.Conceal())
} }
// String returns a string that contains all path elements joined together. // String returns all path elements escaped and joined together as a single string.
// Elements of the path that need escaping are escaped.
// The result is not concealed, and is not suitable for logging or structured // The result is not concealed, and is not suitable for logging or structured
// errors. // errors.
func (pb Builder) String() string { func (pb Builder) String() string {

View File

@ -2,7 +2,6 @@ package path
import "github.com/alcionai/clues" import "github.com/alcionai/clues"
// TODO: Move this into m365/collection/drive
// drivePath is used to represent path components // drivePath is used to represent path components
// of an item within the drive i.e. // of an item within the drive i.e.
// Given `drives/b!X_8Z2zuXpkKkXZsr7gThk9oJpuj0yXVGnK5_VjRRPK-q725SX_8ZQJgFDK8PlFxA/root:/Folder1/Folder2/file` // Given `drives/b!X_8Z2zuXpkKkXZsr7gThk9oJpuj0yXVGnK5_VjRRPK-q725SX_8ZQJgFDK8PlFxA/root:/Folder1/Folder2/file`