Because the shipping system invokes Rules components, the flow of code is really hard to follow.

AFAICT it goes:

- commerce_shipping_collect_rates()
- duck into Rules
- commerce_shipping_method_collect_rates()
- duck into Rules again
- commerce_shipping_service_rate_order()

They're laid out in order in the source, which is great, but a few more docs clues would help to understand this.

CommentFileSizeAuthor
#1 1803272.commerce_shipping.docs-code-flow-clues.patch609 bytesjoachim

Comments

joachim’s picture

joachim commented
Status: Active » Needs review
StatusFileSize
new 1803272.commerce_shipping.docs-code-flow-clues.patch609 bytes

Here's a patch.

rszrama’s picture

rszrama commented
Title: add docs clues to this module's code flow » Provide a developer documentation overview
Assigned: Unassigned » rszrama
Status: Needs review » Active

Because that's not the only way this function might possibly be invoked, I'm hesitant to enshrine one particular code workflow in the doc block for the function. However, I agree that we need a good developer overview of this module and will make it a priority after the 2.0 release. I'll either put this as a topic in the .api.php or create a developer handbook for this module and its child modules.

googletorp’s picture

googletorp commented
Issue summary: View changes
Status: Active » Fixed

I think we have enough documentation.

rszrama’s picture

rszrama commented

Did we ever actually add a topic section to the .api.php, though? I think my ambitions in #2 are still worth pursuing. : P

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.