-
Notifications
You must be signed in to change notification settings - Fork 51
Normalize module names containing multiple objects #155
Copy link
Copy link
Closed
Labels
- Developer -Torrust Improvement ExperienceTorrust Improvement ExperienceDocumentationImproves Instructions, Guides, and NoticesImproves Instructions, Guides, and NoticesNeeds ResearchWe Need to Know More About ThisWe Need to Know More About ThisQuestion / DiscussionCommunity FeedbackCommunity Feedback
Milestone
Description
Sometimes single-file and folder module names containing more than one public struct are singular and sometimes plural.
For example:
src/http/request.rscontains more than one request type.src/http/response.rscontains more than one response type.
In general, the plural is the most used option.
The folder name in the plural is better because it contains a collection of that "thing", but sometimes, when you use the namespace, the singular is easier to read, for example:
request::Announceinstead ofrequests::Announce.
Another advantage of the plural is you do not get Clippy warnings when a function in the module has a suffix which is the mod name, For example, mod handlers and an xxx_handler function inside.
I prefer the plural.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
- Developer -Torrust Improvement ExperienceTorrust Improvement ExperienceDocumentationImproves Instructions, Guides, and NoticesImproves Instructions, Guides, and NoticesNeeds ResearchWe Need to Know More About ThisWe Need to Know More About ThisQuestion / DiscussionCommunity FeedbackCommunity Feedback
Type
Projects
Status
Done