Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

split documentation #156

Merged
merged 9 commits into from
Mar 17, 2021
Merged

split documentation #156

merged 9 commits into from
Mar 17, 2021

Conversation

azjezz
Copy link
Owner

@azjezz azjezz commented Mar 17, 2021

No description provided.

@azjezz azjezz added Priority: Medium This issue may be useful, and needs some attention. Status: Review Needed The issue has a PR attached to it which needs to be reviewed. Type: Enhancement Most issues will probably ask for additions or changes. Type: Documentation Updating documentation labels Mar 17, 2021
@azjezz azjezz added this to the 1.5.0 milestone Mar 17, 2021
@azjezz azjezz requested a review from veewee March 17, 2021 04:30
@azjezz azjezz self-assigned this Mar 17, 2021
@coveralls
Copy link

coveralls commented Mar 17, 2021

Pull Request Test Coverage Report for Build 659902651

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 659510713: 0.0%
Covered Lines: 2809
Relevant Lines: 2809

💛 - Coveralls

@azjezz
Copy link
Owner Author

azjezz commented Mar 17, 2021

also better checks!

image

Copy link
Collaborator

@veewee veewee left a comment

Choose a reason for hiding this comment

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

Very nice and Love the diff!
The documentor code really shows the strength of this package.
Added some possible future improvements as a comment.

{
return [
$components = [
Copy link
Collaborator

Choose a reason for hiding this comment

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

Future improvement is to try to guess all namespaces based on the folder structure (whilst removing the internal once).

Copy link
Owner Author

Choose a reason for hiding this comment

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

The main issue is with things like Psl\Str\Byte, Psl\Encoding\Hex .. etc.

@@ -122,7 +111,7 @@ function get_namespace_documentation(string $namespace): string
}

$definition_line = get_symbol_definition_line($symbol, $type);
Copy link
Collaborator

Choose a reason for hiding this comment

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

The definition line for constants always return 0
Maybe we could use better-reflection to guess constants lines in the future.

https://github.com/Roave/BetterReflection/blob/478ed89e695cbff3ac037ccaa713cb56aee359b4/src/Reflector/ConstantReflector.php#L54

Copy link
Owner Author

Choose a reason for hiding this comment

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

maybe later, for now it's not really important.

@azjezz azjezz merged commit 015ae01 into 1.5.x Mar 17, 2021
@azjezz azjezz deleted the extended-documentation branch March 17, 2021 20:23
@azjezz azjezz added Status: Completed Nothing further to be done with this issue. Awaiting to be closed by the requestor out of politeness and removed Status: Review Needed The issue has a PR attached to it which needs to be reviewed. labels Mar 19, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority: Medium This issue may be useful, and needs some attention. Status: Completed Nothing further to be done with this issue. Awaiting to be closed by the requestor out of politeness Type: Documentation Updating documentation Type: Enhancement Most issues will probably ask for additions or changes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants