Skip to content

Add BaseLabel to the online documentation #144

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

Merged
merged 2 commits into from
Mar 19, 2021
Merged

Add BaseLabel to the online documentation #144

merged 2 commits into from
Mar 19, 2021

Conversation

lesamouraipourpre
Copy link
Contributor

  • Show adafruit_display_text in the API Reference. This makes BaseLabel visible.
  • Change the header in bitmap_label so that it matches the format in label.
  • Other minor tweaks.

If we don't want BaseLabel to be visible in the online documentation, just close this PR.

@tannewt
Copy link
Member

tannewt commented Mar 18, 2021

@jposada202020 Want to review this? I think you added this code.

@FoamyGuy
Copy link
Contributor

FoamyGuy commented Mar 18, 2021

I think that I added this code (and did forget to list in in the api.rst file). The PR is referencing the BaseLabel super class that was made during refactoring to eliminate code duplication. @jposada202020 did the work on baseline alignment in both types of labels.

Jose if you have a chance and are up to it you can go ahead and review this.

I will plan on taking a look at it later tonight though if you don't get to it.

@jposada202020
Copy link
Contributor

@FoamyGuy I did take a look of the code this morning, for me the changes are good to go, I have not built the documentation, I was planning to build the readthedocs to be sure that everything was good. I was going to do it also tonight 😄

@jposada202020
Copy link
Contributor

I verified in an online readthedocs of the proposed changes:

  • Show adafruit_display_text in the API Reference. This makes BaseLabel visible. - GOOD

image

  • Change the header in bitmap_label so that it matches the format in label. GOOD

image

  • Other minor tweaks. GOOD
    Verifications included returns and return type in __init__py
    Verification that the link in line 168 works.
    image

  • Tested on

Adafruit CircuitPython 6.2.0-beta.3 on 2021-03-04; Seeeduino Wio Terminal with samd51p19 

Looks good to me

@FoamyGuy I think we could merge after we say thankyou to @lesamouraipourpre 👍🏼

Copy link
Contributor

@FoamyGuy FoamyGuy left a comment

Choose a reason for hiding this comment

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

I built the docs locally and all of these changes are looking great in there.

Thank you @jposada202020 for looking this over, and trying it out. And thank you @lesamouraipourpre for these docs improvements!

@FoamyGuy FoamyGuy merged commit a71adcd into adafruit:master Mar 19, 2021
adafruit-adabot added a commit to adafruit/Adafruit_CircuitPython_Bundle that referenced this pull request Mar 19, 2021
Updating https://github.com/adafruit/Adafruit_CircuitPython_Display_Text to 2.17.0 from 2.16.0:
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Text#135 from jposada202020/directional_label
  > Merge pull request adafruit/Adafruit_CircuitPython_Display_Text#144 from lesamouraipourpre/docs
@lesamouraipourpre lesamouraipourpre deleted the docs branch March 19, 2021 11:00
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.

4 participants