Exception messages have not always evolved as behavior has evolved. Some exception messages are now wrong, while others are now unhelpful. Proposal:
- Review with a group of people making sure that messages are correct and deciding what to add or remove from the message. Avoid wordsmithing as a team since this is painful and slow.
- Focus on messages commonly seen and consider adding forward links.
- One person (e.g.
@rowanmiller @roji) goes through and writes the messages
- PR review for tweaks
Updated process:
- Each @dotnet/efteam person will go through messages that they understand and check for content based on the checklist below.
- This should not include wordsmithing or items in the style checklist--these will be done by one person per assembly
- Each resource should be marked appropriately in the spreadsheet attached to the Teams channel
- Once this has been completed, we will go through the remaining resources (based on the spreadsheet) as a team
Content checklist:
Style checklist:
See also #22309, #22308, #22374
Specific messages to investigate:
Exception messages have not always evolved as behavior has evolved. Some exception messages are now wrong, while others are now unhelpful. Proposal:
@rowanmiller@roji) goes through and writes the messagesUpdated process:
Content checklist:
Style checklist:
{entityType}.{property/navigation}'rather than'{property/navigation}' of entity type '{entityType}'. Note that this will change the order of parameters, and so call sites will need to be updated.{foreignKey}and for correct quoting and useforeignKeyPropertieswhere appropriate @AndriySvyryd@rojidone @smitpatelSee also #22309, #22308, #22374
Specific messages to investigate:
CircularDependency consider adding a fwlink to a docs pageDocument how circular dependency in data can be resolved EntityFramework.Docs#2619