I have rewritten all module.txt related content to add a lot more detail about the file. The theme.txt section is still todo.
Question - AntiForgery Field
It seems that by default unless you add the enable line in the module.txt it defaults to off. I was expecting that it would be the other way around as this is an important security feature. Am I correct that it defaults off?
Question - FeatureDescription Field
I am a bit unsure as to what the exact point of FeatureDescription. The antispam module.txt doesn't use it at all but according to the spec it should. I'm not sure where it is surfaced or what the advantage of it is.
Question - LifecycleStatus Field
This is only in the dev branch at the moment and it looks like it will be a while before it comes out.
Is it preferred for me to document things as they make it into the codebase or wait until release?
Personally with the amount of work that needs doing at the moment my vote would be to just put it in and don't bother marking it as dev branch as it will create more work to go back and remove later. I wouldn't endorse this as the documentation gets modernised but for right now I do. Thoughts?
CSS improvements
I included some CSS improvements with this commit which make inline code snippets better formatted and some changes to the way tables are rendered:
Rewrite
I have rewritten all module.txt related content to add a lot more detail about the file. The theme.txt section is still todo.
Question -
AntiForgeryFieldIt seems that by default unless you add the
enableline in the module.txt it defaults to off. I was expecting that it would be the other way around as this is an important security feature. Am I correct that it defaults off?Question -
FeatureDescriptionFieldI am a bit unsure as to what the exact point of
FeatureDescription. The antispam module.txt doesn't use it at all but according to the spec it should. I'm not sure where it is surfaced or what the advantage of it is.Question -
LifecycleStatusFieldThis is only in the
devbranch at the moment and it looks like it will be a while before it comes out.Is it preferred for me to document things as they make it into the codebase or wait until release?
Personally with the amount of work that needs doing at the moment my vote would be to just put it in and don't bother marking it as dev branch as it will create more work to go back and remove later. I wouldn't endorse this as the documentation gets modernised but for right now I do. Thoughts?
CSS improvements
I included some CSS improvements with this commit which make inline code snippets better formatted and some changes to the way tables are rendered:
Before
After