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

docs: remove h3 heading from initialization sections #104

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aorumbayev
Copy link
Contributor

@aorumbayev aorumbayev commented Jul 16, 2024

Proposed Changes

  • As per @larkiny bug report, new docs structure included initialization with h3 header while h4 was expected.
  • The pr modified the method that renders the myst code for classes to remove heading from initialization

@aorumbayev aorumbayev changed the title remove h3 heading from initialization sections docs: remove h3 heading from initialization sections Jul 16, 2024
@aorumbayev aorumbayev requested a review from robdmoore July 16, 2024 16:31
Copy link

Coverage

Coverage Report
FileStmtsMissCoverMissing
src/algokit_utils
   _debugging.py140795%20, 41, 76, 80, 89, 129, 157
   _ensure_funded.py69199%99
   _transfer.py67396%13, 76–77
   account.py851385%14–17, 61–65, 96, 109, 136, 139, 183
   application_client.py5287785%58–59, 166, 171, 200, 312, 317–318, 320, 322, 787, 802, 820–823, 913, 953, 965, 978, 1020, 1080–1086, 1090–1095, 1097, 1133, 1140, 1253, 1283, 1297, 1335–1337, 1339, 1349–1406, 1417–1422, 1442–1445
   application_specification.py971189%92, 94, 193–202, 206
   asset.py79594%9, 27–30
   common.py13192%13
   config.py511865%38–39, 50, 55, 60, 64–69, 100–109
   deploy.py4552495%30–33, 168, 172–173, 190, 205, 246, 402, 413–421, 438–441, 451, 459, 652–653, 677
   dispenser_api.py821285%112–113, 117–120, 155–157, 176–178
   logic_error.py38295%6, 29
   models.py125695%45, 50–52, 61–62
   network_clients.py63395%93–94, 125
src/algokit_utils/beta
   account_manager.py551475%39–40, 64, 123–130, 183–187, 198–200
   algorand_client.py1011585%111–112, 121–122, 143–145, 154–155, 224, 259, 274, 290, 303, 319
   client_manager.py371073%40, 61–63, 68–70, 75–78
   composer.py3207178%335–336, 339–340, 343–344, 347–348, 355–356, 359–360, 389, 391, 393, 396, 399, 404, 407, 411, 414, 456–489, 494–505, 510–516, 521–529, 549–562, 566, 590, 593–610, 618, 643, 659–660, 662–663, 665–666, 668–669, 671–672, 678–682
TOTAL241929388% 

Tests Skipped Failures Errors Time
204 0 💤 0 ❌ 0 🔥 3m 10s ⏱️

if init_item:
lines.extend(
[
"Initialization",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@daniel-makerx any idea on how section headings can be tweaked so that init section is collapsed under h4 instead h3 tag. The line that is od

This line initially was "{rubric} Initialization" - which is what renders the ### Initialization, removing the myst block and just keeping #### Initialization doesn't work either and instead it strips the h4 to h3 in the final md.

This addresses the @larkiny 's request to remove init section from same level as the class description itself however setting h4 isn't trivial either. @daniel-makerx unless there is a simple way to tweak that without overriding the method in custom renderer - let me know if we are ok with with init section not being rendered as a section

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.

1 participant