Skip to content

XML Documentation xsd and samples how it could look like#2

Closed
edorian wants to merge 3 commits intosquizlabs:masterfrom
edorian:master
Closed

XML Documentation xsd and samples how it could look like#2
edorian wants to merge 3 commits intosquizlabs:masterfrom
edorian:master

Conversation

@edorian
Copy link
Copy Markdown
Contributor

@edorian edorian commented Nov 9, 2011

Continuing the discussion I had with @gsherwood in #1

I needed recreate the PR because github refused to update the range.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be: Checks all lines in the file and shows warnings or errors if they are too long

@gsherwood
Copy link
Copy Markdown
Member

Besides the above text changes, I really like where this is going. If we can agree on the wording, we're good to go. Although I still need to write some code to substitue those keywords with their correct values based on the standard the user selected.

@edorian
Copy link
Copy Markdown
Contributor Author

edorian commented Nov 11, 2011

I'm sorry about the bad wordings. I didn't proofread this even so i really should have :)

If you want to note the ability to change those values on every sniff that has changeable configuration I'm fine with that.

I'm aware of the abilty to change the values in the ruleset file.. i didn't think about extending the sniff classes to be honest as the xml file is all I ever used :)


Let me know if you find other issues or pull and I'll get started on writing something for every sniff in generic

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thinking more about it, this isn't gong to work. If you have disabled your absoluteLineLimit (set it to zero) then the message will show:
"It is recommended to keep lines at approximately 80 characters long for better code readability and lines should never exceed 0 characters."

We obviously need to devise a smarter system that allows documentation to be generated based on the values that the project-specific standard is setting.

@gsherwood
Copy link
Copy Markdown
Member

I think this is more complex than a pull request is going to achieve. I think we need to start again on this and plan it out properly. It requires changes to the existing documentation generator code as well as changes to the documentation itself.

I also wont be pulling this in if it stops existing documentation from being generated, which it obviously will due to the need to make core changes that have not yet been done.

If you'd like to start creating examples and basic documentation for the existing sniffs using the existing XML format, I'd be very happy to accept those contributions. But I'll need to have a bit more of a think about how best create customised standard documentation.

@edorian
Copy link
Copy Markdown
Contributor Author

edorian commented Nov 21, 2011

Anyways, thanks for getting back to me on this :)

@edorian edorian closed this Nov 21, 2011
rhowardiv referenced this pull request in rhowardiv/PHP_CodeSniffer Jan 2, 2013
Relax class name req's; we're not yet namespacing
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 16, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 17, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Mar 18, 2016
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
…h and open files in that during interactive session
Astinus-Eberhard pushed a commit to Astinus-Eberhard/PHP_CodeSniffer that referenced this pull request Jun 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants