Differential D2810

WIP: Generate and enrich documentation
Needs ReviewPublic
Actions

Authored by dereckson on Feb 24 2023, 19:59.

Tags

None

Referenced Files

	F3558890: D2810.id.diff
	Sat, Sep 7, 08:22

	F3558834: D2810.diff
	Sat, Sep 7, 08:02

	Unknown Object (File)
	Fri, Sep 6, 17:48

	Unknown Object (File)
	Tue, Sep 3, 02:30

	Unknown Object (File)
	Tue, Sep 3, 02:30

	Unknown Object (File)
	Tue, Sep 3, 02:30

	Unknown Object (File)
	Sat, Aug 31, 17:24

	Unknown Object (File)
	Tue, Aug 27, 21:20

Subscribers

None

Details

Reviewers

Test Plan

Generate doc, run enrich script

Diff Detail

Repository

rKERUALD Keruald libraries development repository

Lint

Lint Errors

Severity	Location	Code	Message
Error	omnitools/doc/enrich.py:53	E501	flake8 E501
Error	omnitools/src/Collections/BaseVector.php:155	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:84	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:85	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:124	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:220	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:221	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:253	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:254	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Error	omnitools/src/Identifiers/UUID.php:263	PHPCS.E.Generic.Files.LineLength.MaxExceeded	Generic.Files.LineLength.MaxExceeded
Warning	omnitools/src/Collections/BaseMap.php:9	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseMap.php:36	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseMap.php:43	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseMap.php:53	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseVector.php:118	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseVector.php:135	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseVector.php:153	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseVector.php:156	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Collections/BaseVector.php:224	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Debug/Debugger.php:12	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong
Warning	omnitools/src/Debug/_register_to_global_space.php:10	PHPCS.W.Generic.Files.LineLength.TooLong	Generic.Files.LineLength.TooLong

Unit

Test Failures

Branch

doc

Build Status

Buildable 4458
Build 4725: arc lint + arc unit

Unit TestsBroken
View All

	Time	Test
	0 ms	/usr/home/dereckson/dev/keruald/_monorepo/core/omnitools/tests/Identifiers/UUIDTest.php
	2 ms	Keruald\OmniTools\Tests\Collections\ArrayUtilitiesTest
	77 ms	Keruald\OmniTools\Tests\Debug\DebuggerTest
	1 ms	Keruald\OmniTools\Tests\OS\CurrentProcessTest
	3 ms	Keruald\OmniTools\Tests\OS\EnvironmentTest
		View Full Test Results (1 Broken · 6 Passed)

Event Timeline

dereckson requested review of this revision.Feb 24 2023, 19:59

dereckson created this revision.

Harbormaster completed remote builds in B4457: Diff 7138.Feb 24 2023, 19:59

dereckson mentioned this in D2663: Document UUID class.Feb 24 2023, 19:59

black enrich.py

Harbormaster completed remote builds in B4458: Diff 7139.Feb 24 2023, 20:00

Rebased

Harbormaster completed remote builds in B5084: Diff 8264.Jul 2 2023, 18:34

Revision Contents
Changeset List

Path

Size

1 line

omnitools/

.phan/

2 lines

doc/

29 lines

15 lines

_blocks/

6 lines

22 lines

62 lines

src/

Collections/

ArrayUtilities.php

11 lines

BaseCollection.php

25 lines

77 lines

87 lines

Debug/

22 lines

_register_to_global_space.php

25 lines

Identifiers/

13 lines

OS/

11 lines

CurrentProcess.php

7 lines

Environment.php

26 lines

Registration/

36 lines

PSR4/

PSR4Namespace.php

5 lines

Diff 7139

.gitignore

Loading...

omnitools/.phan/config.php

Loading...

omnitools/doc/Makefile

Loading...

omnitools/doc/README.md

Loading...

omnitools/doc/_blocks/global-ns.html

Loading...

omnitools/doc/doctum.php

Loading...

omnitools/doc/enrich.py

Loading...

omnitools/src/Collections/ArrayUtilities.php

Loading...

omnitools/src/Collections/BaseCollection.php

Loading...

omnitools/src/Collections/BaseMap.php

Loading...

omnitools/src/Collections/BaseVector.php

Loading...

omnitools/src/Debug/Debugger.php

Loading...

omnitools/src/Debug/_register_to_global_space.php

Loading...

omnitools/src/Identifiers/UUID.php

Loading...

omnitools/src/OS/CurrentOS.php

Loading...

omnitools/src/OS/CurrentProcess.php

Loading...

omnitools/src/OS/Environment.php

Loading...

omnitools/src/Registration/Autoloader.php

Loading...

omnitools/src/Registration/PSR4/PSR4Namespace.php

Loading...